How to start Sphinx on Windows#

  1. Check if ‘Python’ >3.3, ‘pip’ and ‘venv’ are installed

  2. run ‘python -m venv <name-of-the-venv>’

  3. Depending on the OS and terminal, activate the venv:

  1. On PowerShell run: ‘<name-of-the-venv>ScriptsActivate.ps1’

  2. On CMD run: ‘<name-of-the-venv>ScriptsActivate.bat’

  3. On Ubuntu run: ‘source <name-of-the-venv>binactivate’

  1. run ‘pip install sphinx’

  2. run ‘sphinx-quickstart docs’

  1. Separate source and build directories? (y/n): y

  2. Project name: <your-project-name>

  3. Author name(s): <author-name(s)>

  4. Project release: 0.1 (actually any number, could be 0.0.1)

  5. Project language [en]: ‘en’ by default

  1. change/update some stuff on config.py