This repo is a fork-ready base for your project's documentation. It lets you host a sphinx-generated site (with the Read the Docs theme) on GitHub Pages using GitHub Actions.
For more information, see this article:
- Fork this repo
- On your forked repo, go to the "Actions" tab and click "I understand my workflows, go ahead and enable them" to enable GitHub workflows
- On your forked repo, go to the "Settings" tab. Under "GitHub Pages" choose 'gh-pages branch' under "Source"
- Make a small change to docs/index.rst
git commitandgit pushsomething to trigger your site to be built
Every time you push to github.com on master, github will automatically spin up a container in their cloud to update your documentation.
After you begin to edit the contents of the site, you'll probably also want to customize the following files:
- docs/conf.py
- The python files in src/
- Other
.rstfiles in docs/ as needed
For more details on how this works, see Continuous Documentation: Hosting Read the Docs on GitHub Pages
The GitHub-Pages-hosted "Hello World" example site built by this repo can be viewed here:
The following Githb-Pages-hosted Read the Docs sites have been created by cloning this repo:
As shown above, you can simply push your changes to GitHub to update your sphinx documentation website.
However, you can also build the site locally on your computer for faster iteration.
To build the site on Debian Linux, first download some dependencies
sudo apt-get update
sudo apt-get -y install git firefox-esr python3-git python3-sphinx python3-sphinx-rtd-theme
Change into the docs directory of this repo and build the sphinx site with make
cd rtd-github-pages/docs/
make clean
make html
You can view the site (built into the _build/html/ directory) using firefox
firefox-esr _build/html/index.html
The contents of this repo are dual-licensed. All code is GPLv3 and all other content is CC-BY-SA.