[Feature request]: sphinx documentation for gempyor API

[pearsonca]

Label

documentation

Priority Label

low priority

Is your feature request related to a problem? Please describe.

Users reported difficulty with documentation for gempyor API. Some portion of that is definition the absence of that documentation, but likely some was also difficulty in finding / accessing the extant documentation.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

Incorporate sphinx documentation generation into build. There are few stages here to implement:

• available for local viewing - i.e. people can start a local docs server and take advantage of the like-a-webpage interface to the docs
• as part of CI, such that sphinx is indicating docstring errors / missingness / etc for build process
• available for web viewing - i.e. an api.flepimop.org site

[emprzy]

Note: inference.py (containing GempyorInference class) and model_info.py (containing ModelInfo class) would most immediately benefit from more thorough documentation.

[TimothyWillard]

A good and brief tutorial on using autodoc with sphinx: https://jackmckew.dev/automatically-generate-documentation-with-sphinx.html.

My preference would be to do the first two tasks under this issue and punt the third task to its own issue and then move this from low to high priority. Thoughts?

[emprzy]

I think that's a good plan.