Set Up Your System

To get started, you need to:

Install Sublime

Get Sublime from Sublime website.

See the following video for installation help.

Learn Sublime

See the following video to get started learning Sublime.

Install Sphinx

To build your document in HTML (or other formats) on your computer, you must install Sphinx.

See Sphinx Overview for background reading. Then follow the steps below.

  1. If you are using Windows, you might need to Install Python.

    Depending on your Windows setup, after installation you might need to manually add the Python directory to your path. Try the Python Windows Install for help.

    If you are using a Mac, it’s probably installed.

  2. Install PIP.

    Depending on your Windows setup, after installation you might need to manually add the PIP directory to your path.

  3. Use PIP to install Sphinx. On the command line, enter:

    $ pip install Sphinx


If you are using Windows, this might be a frustrating task. If you get stuck, share the error messages and ask for help.

You should now be able to create a Sphinx project. See First Steps with Sphinx.

Verify Sphinx Setup

You can use the Get Started with Sphinx Repository to verify that Sphinx is set up. You can also use it as the start of a new project.

  1. Make a fork of the repository and check it out on your computer.

  2. Open a command prompt and change directories to the get_started_sphinx directory.

  3. Run the command make html. Check if there are warnings or errors in the command window.

  4. Check for the HTML output in the get_started_sphinx/build/html directory.

  5. Open the file index.html.

    The page should look like the following image.


If you the HTML is generated and there are no warnings or errors in the command prompt, Sphinx is set up correctly.

Sphinx Videos

These videos are very long and detailed. But they are great resources if you need to complete real projects in Sphinx.

Learn RST

To learn RST syntax, see the RST Primer. Then see the following video.

You can experiment with RST with the Online reStructuredText Editor


Indentation is important in RST. Lots of problems are caused by inconsistent indentation. The only way to learn is to practice and see the results.