Sphinx - Auto Documentation

[bsieber-mozilla]

Currently in the GitHub workflows, we have a mistake; which has prevented it from running and providing value.

ctms-api/.github/workflows/sphinx-pages.yaml

Line 5 in 7c035ae

- master

Changing this to main resulted in the workflow actually running, and failing:

https://github.com/mozilla-it/ctms-api/runs/2551274455?check_suite_focus=true

In live, sphinx auto-docs are not working.

They are able to be produced and could be presented once the build is fixed.

┆Issue is synchronized with this Jira Task

[jwhitlock]

If we don't want to host them, we could build and host on https://readthedocs.org. The changes would be:

• Convert the guides to Sphinx
• Add autodocs
• Add an RTD web hook to the repo (see guide)

[bsieber-mozilla]

I like that approach!

[grahamalama]

Since we no longer use Sphinx to build documentation, we'll close this issue.