You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A follow-on from #47, add a GitHub Action workflow to generate and host via GitHub Pages the built Sphinx documentation pages from the source .rst content.
As part of this Issue, the following should be completed:
Add a GitHub Action workflow to deploy the built docs site to GitHub Pages.
Set the workflow job to run to generate those pages (checking they all render and link as they should).
Configure GitHub Pages via 'Settings' on the repo to host the generated pages as a site.
Update the repository webpage link (currently not specified) to be the link to the landing/index page of the new hosted docs.
If anyone wants to take this on, please feel free and if so, 'assign' yourself here so we know you are working on it. I can do it, but it might be some weeks before I get round to it, so until the point then when I assign myself, I won't be working on it. (And of course I'm happy to provide any guidance relating to the content and infrastructure I added in #47 towards getting this done.)
Essential info.
The documentation source including confirguration and makefile (etc.) is all contained under the docs/ repository. The README document in that directory explains the build process via the core command make html, which is what we need to automate via the Actions workflow.
The text was updated successfully, but these errors were encountered:
A follow-on from #47, add a GitHub Action workflow to generate and host via GitHub Pages the built Sphinx documentation pages from the source
.rst
content.As part of this Issue, the following should be completed:
If anyone wants to take this on, please feel free and if so, 'assign' yourself here so we know you are working on it. I can do it, but it might be some weeks before I get round to it, so until the point then when I assign myself, I won't be working on it. (And of course I'm happy to provide any guidance relating to the content and infrastructure I added in #47 towards getting this done.)
Essential info.
The documentation source including confirguration and makefile (etc.) is all contained under the
docs/
repository. The README document in that directory explains the build process via the core commandmake html
, which is what we need to automate via the Actions workflow.The text was updated successfully, but these errors were encountered: