Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Python process launching
Python

This branch is even with gh-pages

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
_docs_sources
_sources
_static
tutorials
.nojekyll
README.md
compile_docs.py
genindex.html
index.html
learn_more.html
search.html
searchindex.js
special_arguments.html
tutorial.html

README.md

Updating the docs

The doc sources live in /_docs_sources. These are reStructeredText files that compose the final output html after being compiled.

Building

After editing the .rst files, run python compile_docs.py and pass in the sh version number to be embedded in the docs:

python compile_docs.py 1.08

Then commit all of the .html files, all .js and .css files, and the _static, _docs_sources, _sources directories.

Finally, submit a pull request with your changes.

Something went wrong with that request. Please try again.