Skip to content

Latest commit

 

History

History
17 lines (10 loc) · 649 Bytes

README.md

File metadata and controls

17 lines (10 loc) · 649 Bytes

Building

We're using travis to autobuild docs. Any changes to master will create new sphinx docs in gh-pages.

We're using sphinx_rtd_theme make sure to pip install sphinx_rtd_theme to build

Use sphinx-apidoc ../ -o source/ -e -f to generate sources and insert them into source/.

Edit source/config.py to bump the version or change settings

To build run: make html

Docs can be found in docs/build/html/index.html

requirements.txt found in this folder contains sphinx and the sphinx theme

To push docs live, move ./build/html/ into gh-pages branch.