Have automated docs generation based on code
What
Documentation should be generated from the comments in your code
Why
Having automated documentation ensures developers have up-to-date information about how code functions.
When
Pre Release
Implementations:
- Sphinx
- Provides a way to generate code documentation and other non-code based documentation
- Works well in mixed-language codebases
- Requires the use of tools like napoleon to handle standard formats like numpy or Google
- pdoc
- Simple to use, does not require extensions
- Very opinionated on how docs should
- Only extracts public API docs by default
- Doxygen
- Provides a way to generate documentation for multiple languages
Recommendation:
Sphinx