Support Sphinx

[CasperWA]

Closes #90

Support building and deploying Sphinx-based documentation.

Implement Sphinx-framework in callable workflows:

• CD - Release
• CI - Tests
• CI/CD - Updates to default branch

[codecov-commenter]

Codecov Report

Merging #92 (e8006a6) into main (9dc7eb7) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #92   +/-   ##
=======================================
  Coverage   65.67%   65.67%           
=======================================
  Files           9        9           
  Lines         472      472           
=======================================
  Hits          310      310           
  Misses        162      162           

[francescalb]

There are some things in here that seem to me to be outside the scope of this PR. That is fine, but makes is a little more difficult to review. Is there a way to preview how the documentation (of this PR) will change? That would be useful to review if I really understand how I can use this repo.

[CasperWA]

There are some things in here that seem to me to be outside the scope of this PR. That is fine, but makes is a little more difficult to review. (...)

That's fair. I can try to split it up as best as I can, moving the out-of-scope stuff for another PR if

(...) Is there a way to preview how the documentation (of this PR) will change? That would be useful to review if I really understand how I can use this repo.

You can run it locally. There is a way to set it up so that a temporary documentation is created for each PR as well, but this requires using third-party services that are not setup for this repository (and would take more time than what is useful for now).

To run it locally do (ensuring you're in a virtual environment):

# Get the repository locally
git clone git@github.com:SINTEF/ci-cd.git
cd ci-cd

# Checkout the PR branch
git checkout cwa/close-90-support-sphinx-docs

# Install ci-cd with tools for running the documentation
pip install -U pip setuptools wheel flit
pip install -U -e .[docs]

# Build and run a local server with the documentation
mkdocs serve

Then go to the URL written to your terminal after the last command.

[francescalb]

There are some things in here that seem to me to be outside the scope of this PR. That is fine, but makes is a little more difficult to review. (...)

That's fair. I can try to split it up as best as I can, moving the out-of-scope stuff for another PR if

(...) Is there a way to preview how the documentation (of this PR) will change? That would be useful to review if I really understand how I can use this repo.

You can run it locally. There is a way to set it up so that a temporary documentation is created for each PR as well, but this requires using third-party services that are not setup for this repository (and would take more time than what is useful for now).

To run it locally do (ensuring you're in a virtual environment):

# Get the repository locally
git clone git@github.com:SINTEF/ci-cd.git
cd ci-cd

# Checkout the PR branch
git checkout cwa/close-90-support-sphinx-docs

# Install ci-cd with tools for running the documentation
pip install -U pip setuptools wheel flit
pip install -U -e .[docs]

# Build and run a local server with the documentation
mkdocs serve

Then go to the URL written to your terminal after the last command.

Don't bother spending time on splitting up now. It was more a comment for the future :)
I'll look at ut locally, but I wan wionderling if there was a tool like git diff or something that would point me to where the documentation has changed. I'll look at it locally as you suggest.