Tools
Here is a list of tools which will help you to write documentation.
VSCode extensions
Python Docstring Generator
Note
Automatically generates the right docstring format for methods / functions / classes ...
Install python docstring generator
Select the
sphinx
format for the auto docstring functionality
![Python Docstring Generator, auto docstring sphinx](../../_images/docstring_format.png)
reStructuredText Syntax highlighting
Note
Syntax highlighting and document symbols for reStructuredText
This extension uses Esbonio
Select the right output for sphinx-build in the settings:
![reStructuredText syntax highlighting, set output path sphinx-build](../../_images/esbonio_output_sphinx_build.png)