RST Workshop: Development Environment

The development environment for this workshop consists of:

Environment Setup

  1. Install Visual Studio Code.

  2. Install reStructuredText Extension for Visual Studio Code.

  3. Open a Linux shell and install Sphinx and the required extensions.

    sudo apt-get update && sudo apt upgrade
    sudo apt-get -y install python3-pip
    pip3 install Sphinx
    pip3 install sphinx-autobuild

Create a Project

  1. Create a project directory

  2. Use sphinx-quickstart to create a new Sphinx projects

    • Open a terminal in VSC (Terminal -> New Terminal)

    • Open up a linux shell

    • Execute: sphinx-quickstart

    • Follow the prompts

Configure LiveReload

  1. Clone sphinx-server from


    This project needs to be in /opt/sphinx-server

    cd /opt
    sudo git clone
  2. Copy file to your project root.

    cd /mnt/c/Users/user/source/rst/my-project
    cp /opt/sphinx-server/ .
  3. Start the mini-server that uses autobuild and livereload.


    python3 only

    Using python will generate this error:

    Traceback (most recent call last):
      File "", line 7, in <module>
        import http.server
    ImportError: No module named http.server


    Start python3 using the built-in terminal in VSC!

    1. Terminal -> New Terminal

    2. bash

    3. python3

  4. Open your browser to http://localhost:8000/.