Documentation¶
Building¶
Building meshrender’s documentation requires a few extra dependencies – specifically, sphinx and a few plugins.
To install the dependencies required, simply change directories into the autolab_core source and run
$ pip install .[docs]
Then, go to the docs directory and run make with the appropriate target.
For example,
$ cd docs/
$ make html
will generate a set of web pages. Any documentation files generated in this manner can be found in docs/build.
Deploying¶
To deploy documentation to the Github Pages site for the repository, simply push any changes to the documentation source to master and then run
$ . gh_deploy.sh
from the docs folder. This script will automatically checkout the
gh-pages branch, build the documentation from source, and push it
to Github.