5.8. Documenting source code (TBC)

Important

It is recommended to use the reST docstring format as it is supported by a number of IDEs including PyCharm, Visual Studio Code, Eclipse (remember that your code will be use by others who may not be using the same IDE).

Documenting Python source code with docstrings in IDEs

Pycharm

1. Getting started

1. Specify the reST docstring format

2. Enabling documentation comments

3. Create documentation comments in source code

2. Specify variable types with docstrnigs

3. Type hinting

4. Updating documentation with PyCharm

Automatically generating API documentation from docstrings

Generating api documentation using sphinx-autoapi