Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
52 lines (34 sloc) 1.88 KB

Contributing to this repository

Building the project locally

Installing the requirements

Install the sphinx and sphinx-autobuild python utilities:

pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark --user


The --user flag is to install these libraries into your user directory to avoid problems with your system install. You can also use virtualenv to create a per-directory python virtual environment.

Ensure that the sphinx-build and sphinx-autobuild commands are accessible to your terminal.

On Mac OS X, add the following entry to your ~/.bashrc. Be sure to use the $HOME variable and not ~ as this may cause issues running sphinx-build:

export PATH=$HOME/Library/Python/2.7/bin:$PATH

On Linux, this would probably be:

export PATH=$HOME/.local/bin:$PATH

You may need to run source ~/.bashrc to ensure the access to the commands. You can add source ~/.bashrc to your ~/.bash_profile (or possibly ~/.profile) to automate this step.

Building the docs

You have two options for viewing the docs locally. You can build the docs using make html and then open the _build/html/index.html file in your browser.

Alternatively, run make livehtml and navigate to http://localhost:8000 to view the docs. The HTML is updated as you edit the Markdown source files — no browser reload required!

Submitting your changes

To contribute to the docs at

  1. Fork this repository
  2. Make your changes a. Edit an existing file b. If creating a new file, add a line entry to index.rst that corresponds to the new filename that you added
  3. Run the tests with ./
  4. Submit a pull request for the team to review
You can’t perform that action at this time.