GreenScheduler / cats

CATS: the Climate-Aware Task Scheduler :cat2: :tiger2: :leopard:
https://greenscheduler.github.io/cats/
MIT License
50 stars 8 forks source link

Deploy the documentation site via a GitHub Action #48

Closed sadielbartholomew closed 1 year ago

sadielbartholomew commented 1 year ago

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 command make html, which is what we need to automate via the Actions workflow.

tlestang commented 1 year ago

Merged #51 in

ljcolling commented 1 year ago

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

sadielbartholomew commented 1 year ago

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