Add API reference documentation for ci-cd

[CasperWA]

Part 2 of closing #95.

To do:

• Rebase on main after Update Python API #109 has been merged.

Add API reference documentation for this repository to the documentation at SINTEF.github.io/ci-cd.

Note, this is part 2 of 3 of a new set of PRs that replace #99.

Closes #113

[codecov-commenter]

Codecov Report

Merging #110 (b4609e6) into main (2e0929c) will increase coverage by 3.91%.
The diff coverage is 57.74%.

@@            Coverage Diff             @@
##             main     #110      +/-   ##
==========================================
+ Coverage   53.69%   57.61%   +3.91%     
==========================================
  Files           3        8       +5     
  Lines         311      361      +50     
==========================================
+ Hits          167      208      +41     
- Misses        144      153       +9     

Impacted Files	Coverage Δ
ci_cd/tasks/docs_index.py	23.33% <23.33%> (ø)
ci_cd/tasks/setver.py	23.52% <23.52%> (ø)
ci_cd/tasks/api_reference_docs.py	65.41% <65.41%> (ø)
ci_cd/tasks/update_deps.py	68.81% <68.81%> (ø)
ci_cd/utils.py	69.76% <69.76%> (ø)
ci_cd/tasks/__init__.py	100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[francescalb]

How do I test that the documentation is properly generated?

What are the codecov warnings about newly added lines? They do not seem to be newly added in this PR, but is sounds like that from the codecov issues.

[CasperWA]

How do I test that the documentation is properly generated?

You could generate it locally? Or you could check the CI/CD workflow that builds the documentation and that it doesn't fail? So that would be this run.

To generate it locally:

1. Install ci-cd with the docs or dev extra.
2. Run mkdocs build to build it.
3. Run mkdocs serve to build and then serve the documentation locally.

What are the codecov warnings about newly added lines? They do not seem to be newly added in this PR, but is sounds like that from the codecov issues.

I think this is a timing issue, since these PRs were created simultaneously, but built upon each other. So while the changes codecov reference have now been merged into main from the previous PR, codecov still ran when these changes weren't merged, so it flagged these lines in its run. I'm sure if it runs again, for some reason (if I add more commits) they should go away. We'll see I suppose.

[francescalb]

Good.

[francescalb]

Good I was missing the mkdocs serve.