Generating documentation generation with sphinx

Documentation is king when it comes to supporting consumers of your code and convincing newcomers that it actually makes sense to buy in and use your package. For most people, a documentation website is the first place they go to learn about the package. It is, by definition, assumed to be the single source of truth on the code in its current version. 

The role of documentation is usually threefold:

  • Explain how to install your package and what the general requirements are (for example, which Python versions are supported)
  • Show how to use the package (preferably with a quick example showing its immediate value)
  • Express the general idea and philosophy of the package

A documentation website does ...

Get Learn Python by Building Data Science Applications now with O’Reilly online learning.

O’Reilly members experience live online training, plus books, videos, and digital content from 200+ publishers.