Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
80 lines (55 sloc) 2.81 KB

Prerequisites

This article shows what dependencies are required by different features.

Install Python for Most Features

reStructuredText is a technology created by Python community, so most of the toolchain is built upon Python. It is very important to install Python in advance.

  1. Download python version 3.4 or above (2.x might work, but no guarantee).
  2. If you are installing on Windows, ensure both the Python install directory and the Python scripts directory have been added to your PATH environment variable. For example, if you install Python into the c:\python34 directory, you can add c:\python34;c:\python34\scripts to your PATH environment variable.

Important

It is recommended that you install the Python extension by Microsoft. It really makes configuring Python environment easier for users.

Note

Latest steps on how to install Python and Sphinx, please refer to this article.

Important

Python virtualenv is supported, but its setup is complex and not documented here yet.

Install DocUtils or Sphinx for Live Preview

Live preview requires either DocUtils or Sphinx to be installed in advance, as rendering engine to generate the HTML page for preview. The selection of rendering engine and Sphinx conf.py files can be made by clicking the status button. Please refer to :doc:`/articles/configuration` for details.

#. Install DocUtls by opening a command prompt and running the following Python command,

pip install docutils

Note

If you prefer Sphinx based preview, then this step is optional.

#. Install Sphinx by opening a command prompt and running the following Python command,

pip install sphinx sphinx-autobuild

Note

This operation might take a few minutes to complete.

If you prefer DocUtils based preview, then this step is optional.

Note

Some Sphinx themes require their own Python packages to be installed. You should check the documentation of the themes you use so as to know which packages to install, or the preview error page contains the actual package name which is missing.

Install Doc8 for Linter

Linting support requires the doc8 engine.

  1. Install doc8 to enable linter support.

    pip install doc8
    

    Note

    If you prefer not to use linter, then this step is optional.

Related Resources