huitang-earth / rtd-github-pages

Fork-ready base for your project's documentation using Sphinx + Read the Docs on GitHub Pages

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:

• https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/

How to use this repo

1. Fork this repo
2. On your forked repo, go to the "Actions" tab and click "I understand my workflows, go ahead and enable them" to enable GitHub workflows
3. On your forked repo, go to the "Settings" tab. Under "GitHub Pages" choose 'gh-pages branch' under "Source"
4. Make a small change to docs/index.rst
5. git commit and git 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.

After you begin to edit the contents of the site, you'll probably also want to customize the following files:

1. docs/conf.py
2. The python files in src/
3. Other .rst files in docs/ as needed

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:

• https://maltfield.github.io/rtd-github-pages/

In the wild

The following Githb-Pages-hosted Read the Docs sites have been created by cloning this repo:

• BusKill Docs (repo)
• Python Bootcamp for Science (repo)
• Py4Web Docs (repo)

License

The contents of this repo are dual-licensed. All code is GPLv3 and all other content is CC-BY-SA.