Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish documentation to GitHub Pages #53

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ptheywood
Copy link
Member

@ptheywood ptheywood commented Jul 6, 2021

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 the gh-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 as bede-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 the cname on https://github.com/FLAMEGPU/FLAMEGPU2-doc.

Todo:

  • Consider using force_orphan: true with option of peaceiris/actions-gh-pages
  • Select the subdomain to use (discussions required)
  • Update the PR with the CNAME set + html_baseurl in conf.py
  • Get the appropraite DNS settings applied (requires access from others)
  • gh-pages may need to be enabeld in the repository settings (directed at the gh-pages) branch.

Once merged:

  • Update RTD to redirect / link users to the canonincal CNAME url.
  • Update website content which currently links to RTD to link to the subdomain cname.

This will close #10 and close #8

@ptheywood
Copy link
Member Author

ptheywood commented Jul 28, 2021

I've adjusted the demo to host the page at a subdomain: https://bede-docs-demo.ptheywood.uk/ showing how it could work. This will show https warnings until certificates have propagated.

I've reached out on slack to enquire about the domain name other bede support would be keen for, suggesting bede-documentation.n8cir.org.uk, or bede-docs.n8cir.org.uk initially.

@ptheywood ptheywood force-pushed the docs-on-ghpages branch 3 times, most recently from 97b2110 to 74357ed Compare February 10, 2022 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

documentation website shows adds (readthedocs) Use N8 CIR subdomain if sticking with ReadTheDocs
1 participant