My personal site
https://mcsinyx.github.io
159b7faff2
https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1 |
||
---|---|---|
.github/workflows | ||
docs | ||
src | ||
.gitignore | ||
LICENSE | ||
README.md |
README.md
Continuous Documentation: Hosting Read the Docs on GitHub Pages
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:
How to use this repo
- 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"
- Edit the files in src/ and docs/ as needed
git commit
andgit push
something 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.
For more details on how this works, see Continuous Documentation: Hosting Read the Docs on GitHub Pages
Demo
The GitHub-Pages-hosted "Hello World" example site built by this repo can be viewed here:
License
The contents of this repo are dual-licensed. All code is GPLv3 and all other content is CC-BY-SA.