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

Deploy the documentation site via a GitHub Action #48

Closed
5 tasks done
sadielbartholomew opened this issue Jun 23, 2023 · 3 comments
Closed
5 tasks done

Deploy the documentation site via a GitHub Action #48

sadielbartholomew opened this issue Jun 23, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sadielbartholomew
Copy link
Member

sadielbartholomew commented Jun 23, 2023

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 'LINK-PENDING' in the README in the first sentence under the 'Documentation' heading to point to the link of the landing/index page of the new hosted docs.
  • 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.

@sadielbartholomew sadielbartholomew added the documentation Improvements or additions to documentation label Jun 23, 2023
@tlestang tlestang self-assigned this Jul 14, 2023
tlestang added a commit that referenced this issue Jul 14, 2023
@tlestang
Copy link
Collaborator

tlestang commented Aug 3, 2023

Merged #51 in

@ljcolling
Copy link
Contributor

Is it ok to close this now @tlestang and @sadielbartholomew... all the tasks are now completed

@sadielbartholomew
Copy link
Member Author

Fantastic stuff. Agreed, we can close, though note the follow-on issue I am putting up relating to the API reference...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants