- 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 commit
andgit push
something to trigger your site to be built
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
.rst
files in docs/ as needed
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:
The contents of this repo are dual-licensed. All code is GPLv3 and all other content is CC-BY-SA.