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.

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

  • For more on reStructuredText, see VSCode reStructuredText

  • This extension provides rich reStructuredText language support.

  • Syntax Highlighting (via reStructuredText Syntax highlighting extension)

  • IntelliSense (via Esbonio extension)

  • Live Preview (via Esbonio extension)


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.

  • This provides syntax highlighting and document symbols for reStructuredText


5.4. Install VSCode Esbonio extension

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

  • Type Esbonio into the search box.

  • The Esbonio extension integrates the esbonio language server into VSCode.

  • The esbonio language server aims to make it easier to work with Sphinx documentation projects by providing completion suggestions.


5.5. VSCode Path Separator

  • In the settings editor, search for Explorer: Copy Relative Path Separator.

  • Set the value to / (forward slash).

  • This will ensure that when you right-click on project files and select Copy Relative Path, the path separator will be a forward slash.

  • This will be hand when adding files to the index.rst file.