We are using Sphinx with Google-style docstrings to build our documentation. It's a fairly straightforward process to build the docs locally to preview your changes. There is a script for deployment to gh-pages, described below.

We obviously require sphinx for this, but (sphinx_bootstrap)[https://github.com/ryan-roemer/sphinx-bootstrap-theme] is required for building the docs in Bootstrap.

on osx:

pip install sphinx
pip install recommonmark
pip install sphinx-bootstrap-theme
pip install sphinxcontrib-napoleon

This will build the docs locally for testing and future deployment.

cd tweet_parser/docs
make clean
make html

From the root of the repo run:

bash doc_build.sh <BRANCH_NAME>

where <BRANCH_NAME> is the name of the branch you'll be building from, most likely master. The script will change to the gh-pages branch, clean out the olds docs, pull your changes from the relevant branch, build them, and give you instructions for review and commands for deployment.