9. Contributing to this repository¶
9.1. Building the project locally¶
9.1.1. Installing the requirements¶
sphinx-autobuild python utilities:
pip install sphinx sphinx-autobuild sphinx_rtd_theme recommonmark --user
--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-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
On Linux, this would probably be:
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
to automate this step.
9.1.2. 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.
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!
9.2. Submitting your changes¶
To contribute to the docs at
- Fork this repository
- Make your changes
a. Edit an existing file
b. If creating a new file, add a line entry to
index.rstthat corresponds to the new filename that you added
- Run the tests with
- Submit a pull request for the team to review