5. VSCode

  • VSCode has Integrated Git, debugging and extensions for Python and reStructuredText.

  • In VSCode, create your documentation as plain text source files in reStructuredText (.rst) format.


5.1. Install VSCode


5.2. Install VSCode reStructuredText extension

  • In VSCode, click the Extensions icon in the left side bar.

  • Type reStructuredText into the search box.

  • Install reStructuredText extension.

Warning

Be careful to not go past v 173 of reStructuredText since viewing the .rst files is broken in all of the latest versions (tested to v189).

  • In VSCode, create your documentation as plain text source files in reStructuredText (.rst) format.

  • For more on reStructuredText, see VSCode reStructuredText


5.3. Install VSCode reStructuredText Syntax highlighting extension

  • In VSCode, click the Extensions icon in the left side bar.

  • Type reStructuredText Syntax highlighting into the search box.

  • Install reStructuredText Syntax highlighting extension.