Tools

Here is a list of tools which will help you to write documentation.

1. VSCode extensions

   1. Python Docstring Generator

   2. reStructuredText Syntax highlighting

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

reStructuredText Syntax highlighting

Note

Syntax highlighting and document symbols for reStructuredText

• Install reStructuredText syntax highlighting

• This extension uses Esbonio

• Select the right output for sphinx-build in the settings: