Class 4 - documentation

During class we covered how to write Python docstrings in Python code and how to use Sphinx to prepare Python package documentation. We started with this version of td_pathways package and ended with the final version.

Topics covered:

1. Using Sphinx quickstart to generate initial documentation.
2. Manually using Sphinx directives from Python domain to document a function.
3. Using autodoc extension to generate documentation of individual functions and classes.
4. Using autodoc extension to generate documentation of whole modules.
5. Creating narrative documentation with IPython extension.
6. Creating narrative documentation with jupyter notebooks thanks to myst-nd parser.
7. Using intersphinx extension to refer to objects from other packages on the internet.