1. Install Guide

1.1. install python

  • python 3.9.6 or later

    svn://fbserver/Common/Document/Sphinx/trunk/lib/python-3.9.6-amd64.exe

    check Add Path during install python

    _images/install_python.png

1.2. install shpinx

  • dos command

    >pip install sphinx
>pip install sphinx-autobuild

1.3. install vscode

  • vscode 1.62 or later

    svn://fbserver/Common/Document/Sphinx/trunk/lib/VSCodeUserSetup-x64-1.62.0.exe

1.4. install vscode extension

1.4.1. install Extension Pack for RestructuredText

  • run vscode

  • search extension “Extension Pack for RestructuredText”

    _images/rest.png

  • install “Extension Pack for RestructuredText”

1.4.2. install reStructuredText Syntax highlighting

  • search extension “reStructuredText Syntax highlighting”

    _images/rest_highlight.png

  • install “reStructuredText Syntax highlighting”

1.4.3. install Preview

  • search extension “Preview”

    _images/preview.png

  • install “Preview”

  • to use preview, select *.rst, press Ctrl-Shift-R

    _images/preview_2nd.png

1.5. Run VS Code

  • restart vscode

  • open folder in vscode

    _images/openfolder.png

    select Sphinx SVN folder such as D:\SVNSource\Document\Sphinx\trunk\SphinxTutorial

  • edit conf.py, if you are document manager

  • edit index.rst, if you are document manager

  • edit install.rst to update installation process

  • edit Tutorial_Sphinx\Tutorial_Sphinx.rst to update Sphinx Tutorial