Read the original article on my blog
In this fifth installment of the Hypermodern Python series, I’m going to discuss how to add documentation to your project.¹ In the previous chapter, we discussed how to add type annotations and type checking. (If you start reading here, you can also download the code for the previous chapter.)
Here are the topics covered in this chapter on documentation:
- Documenting code with Python docstrings
- Linting code documentation with flake8-docstrings
- Adding docstrings to Nox sessions
- Adding docstrings to the test suite
- Validating docstrings against function signatures with darglint
- Running documentation examples with xdoctest
- Creating documentation with Sphinx
- Writing documentation using reStructuredText
- Generating API documentation with autodoc
Here is a full list of the articles in this series:
