Open
Description
- From our refactoring wishlist: Refactoring wishlist (Meeting notes 2021-07-28) #1291
While markdown has become very popular, the preferred documentation tool for Python projects is RestructuredText and there is support for better doctests through Sphinx if you use ReST. We already use sphinx to build for Read The Docs, so what we'd need to do here is:
- Convert our documentation to ReST format (exception: we probably want to leave README.md as it is, and some files don't have code so there's no need to convert them)
- Set up any code examples as doctests (and add new ones as needed)
- Make sure they run correctly
I'd suggest we start with the how-to guides or possibly the manual. I wouldn't expect this to be a quick process.