contentctl icon indicating copy to clipboard operation
contentctl copied to clipboard

Consider deploying sphinx for autodocs

Open cmcginley-splunk opened this issue 1 year ago • 1 comments

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.

cmcginley-splunk avatar Sep 11 '24 23:09 cmcginley-splunk

https://sphinx-pydantic.readthedocs.io/en/latest/

or

https://github.com/mansenfranzen/autodoc_pydantic

cmcginley-splunk avatar Sep 12 '24 17:09 cmcginley-splunk