[TASK] Reusable CI/CD Pipeline for Sphinx

[kluge7]

Description of task

We need a reusable GitHub Actions workflow to streamline the generation and deployment of our documentation using Sphinx. Sphinx is a powerful tool for generating structured documentation in formats like HTML, LaTeX, and more. Automating this process will ensure that our documentation is always up-to-date and easily accessible. The pipeline should be called on push to main, so that it will make a new html file and deploy it to Github Pages!

Specifications

• The workflow generates Sphinx documentation successfully on each run.
• Artifacts of generated HTML are available for review on GitHub Actions.
• Documentation is deployed to GitHub Pages.
• The workflow is reusable across repositories.

Contacts

@Senja20

[kluge7]

https://github.com/marketplace/actions/sphinx-build

[kluge7]

Just to clarify, I think Sphinx only works per repo, so I dont think its possible to have it all in a single Github Page site directly. Instead, we should set it up so that each repository generates its own GitHub Pages site, from this workflow. For example, if this pipeline is implemented in the vortex-auv repository, it would generate documentation specifically for that repo. Does that make sense?

@VegraD @Senja20

[VegraD]

It seems that each repository needs to be set up to facilitate building the pages. See: https://www.sphinx-doc.org/en/master/tutorial/automatic-doc-generation.html for how this is done. Should look at the possibility of generating a .rst file in the repository where necessary, so that the page can be generated fully automatically.