Add a build and deploy pipeline for the docs

[MyPyDavid]

I think the last merged PR is not yet deployed to https://rdmo.readthedocs.io/, there is no mention of "Keycloak" yet https://rdmo.readthedocs.io/en/latest/search.html?q=keycloak&check_keywords=yes&area=default.

• latest build failed: https://readthedocs.org/projects/rdmo/builds/18108499/

Suggestion: It would be easier to have here a pipeline installed via the Github Actions or via a webhook integration:

• https://docs.readthedocs.io/en/stable/integrations.html#github

[MyPyDavid]

we can use https://github.com/rdmorganiser/rdmo/blob/master/.github/workflows/ci.yml as inspiration

[jochenklar]

We could also drop readthedocs (because of the advertisement) and deploy it to rdmorganiser.github.io/docs/ or even move everything to rdmo.org, which I accidentally own :grin: .

[afuetterer]

What do you prefer?

• [ ] rdmo.readthedocs.io
• [ ] rdmorganiser.github.io/rdmo <- docs could move to rdmo repo again and be built and deployed on each release on master
• [ ] rdmorganiser.github.io/docs
• [ ] rdmo.org

I would stick with GitHub pages or readthedocs.

Did you decide on having "only" the latest docs online?

I am confused about the usage of RDMO_VERSION in the docs, which is only rendered locally but shown as latest on rtd.

https://github.com/rdmorganiser/rdmo-docs-en/blob/068696278b7dbb54477ecf71b44903cc3978770d/docs/conf.py#L3

[afuetterer]

If there should be no deploy pipeline for the docs, I would still propose adding a CI job to lint, build and linkcheck. What do you think?

e.g. ruff (only conf.py, maybe overkill), markdownlint (for the md files), and pre-commit hooks for trailing whitespace etc.

[jochenklar]

I like rdmorganiser.github.io/docs but then we need some kind of dummy repo to guide users from rdmo.readthedocs.io to that page. (or a redirect). We would get rid of the ads.