documentation

[caver456]

This would be reeely nice to have before publishing 2.0.0 to PyPi.

• [ ] intro and overview
  • [x] key features
  • [x] CTD or internet
  • [x] config file
  • [x] authentication / signed requests
  • [x] local cache
  • [x] sync
  • [x] mapless
  • [ ] fixed string lists
    • [ ] POD
    • [ ] assignment status
    • [ ] resource type
    • [ ] gps type
    • [ ] feature class
• [x] document each function
  • [x] add docstrings (use autodocstring as a starting point)
  • [x] modify signatures as needed
  • [x] modify function names as needed (prepend internal functions with underscore)
• [x] sidebar TOC
  • [x] global toc on sidebar of every page: list of links to all pages
  • [x] index / front page
  • [x] class reference
  • [x] credentials
  • [x] local toc on index / front page
  • [x] installation
  • [x] key features
  • [x] examples
  • [x] local toc on class reference page
  • [x] categorized class methods
• [ ] complete QA since signatures changed
• [x] run sphinx
• [ ] build to readthedocs

[caver456]

There are a lot of issues that 'could' be progressing right now, which kind of causes gridlock. So - here's the current game plan:

place all subsequent issues on hold; wrap up documentation in its current state, including full QA, then merge this branch before moving on with the other branches.

This does include clarifying that new map creation only works on CTD right now. Should probably add some code to provide warnings and graceful failures when the user tries to create a map on caltopo.com / sartopo.com.