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
- Edit the files in src/ and docs/ as needed
When you push to github.com on master, github will automatically spin up a container in their cloud to update your documentation.
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 contents of this repo are dual-licensed. All code is GPLv3 and all other content is CC-BY-SA.