McSinyx/mcsinyx.github.io
McSinyx
/
mcsinyx.github.io
mirror of https://github.com/McSinyx/mcsinyx.github.io
1
0
Fork 0
Code Releases Activity
mcsinyx.github.io/README.md

1.6 KiB
Raw Blame History

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.

Continuous Documentation with Read the Docs on GitHub Pages using GitHub Actions

For more information, see this article:

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. Edit the files in src/ and docs/ as needed
  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.

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.