Docs

Hello. Thanks for stopping by. This is a work in progress.

Development

Section hierarchy

#########
Heading 1
#########

*********
Heading 2
*********

Heading 3
=========

Heading 4
---------

Heading 5
^^^^^^^^^

Environment

(on OSX)

# install python
brew install python3
# install virtualenv
pip install virtualenv
# create Python environment
virtualenv -p /usr/local/bin/python3 venv
# open the Python environment
source venv/bin/activate
# install requirements
pip install -r requirements.txt

More on virtualenv.

Use sphinx-autobuild to automatically watch for changes and rebuild the html site using:

make livehtml

To stop the server press Ctrl+C.

Run make deploy to test for errors before pushing to production (any warnings will cause the travis-ci build to fail).

Travis-CI

You don't need to do anything with this if contributing. But if you want to fork this site for your own needs, you'll need to install. Check out the Travis-CI docs for Building a Python Project and GitHub Pages Deployment. Personal access token with 'public_repo - Access public repositories' permissions created and used it in travis encrypt GH_TOKEN=my_github_token --add env.matrix as described in the Travis-CI docs.