A template sphinx project using the rtd theme setup for Github Pages
pip install sphinx sphinx_rtd_theme
- Run
make html
from the repository's root directory. This will generate abuild
directory and also copies necessary files to thedocs
directory for serving the site with Github Pages.
Note: You must direct Github pages to build from the docs directory
Settings->Pages->Build and Deployment->Branch