contentctl
contentctl copied to clipboard
Consider deploying sphinx for autodocs
Sphinx provides great utilities for auto-generating docs for code based on docstrings. We should consider utilizing it and publishing our docs using it. Note that to get the most out of it we would need to enforce reST style docstrings on all classes, modules, functions and class/instance attributes.
https://sphinx-pydantic.readthedocs.io/en/latest/
or
https://github.com/mansenfranzen/autodoc_pydantic