Publish documentation to GitHub Pages #53
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As an alternative to read the docs, the documentation can be published to GitHub Pages via actions. This will remove the adverts seen on free RTD.
This adds a new GitHub Action workflow, Publish.yml, which on push to the
main
branch, builds the documentation and if the build is successfull the generated html is commited to thegh-pages
branch.This will then be available via a github pages, initially at https://n8-cir-bede.github.io/documenation (I think).
If this route is to be pursued, the workflow can be ammended to also set the
CNAME
option, allowing the documentation to be published at a custom (sub)domain, such asbede-documentaion.n8cir.org.uk
?.To demonstrate this worked, my fork's main repository currently contains a (slightly modified) version of the action demonstrating it works, which hosts the content at
https://ptheywood.uk/bede-documentation/https://bede-docs-demo.ptheywood.uk/ (This will not be permanent).A similar example showing the use of a custom subdomain can be found at https://docs.flamegpu.com/, which sets
docs.flamegpu.com
as thecname
on https://github.com/FLAMEGPU/FLAMEGPU2-doc.Todo:
force_orphan: true
with
option ofpeaceiris/actions-gh-pages
html_baseurl
inconf.py
Once merged:
This will close #10 and close #8