Merge pull request #156 from transientskp/add-description-of-source-params-to-generated-docs

Add description of source params to generated docs

Author: HannoSpreeuw

docs/source/conf.py

@@ -38,6 +38,7 @@
     "sphinx.ext.extlinks",
     "numpydoc",
     "autoapi.extension",
+    "enum_tools.autoenum",
 ]
 
 autodoc_typehints = "both"

docs/source/index.rst

@@ -5,6 +5,7 @@ Welcome to PySE's documentation!
    :maxdepth: 2
 
    README
+   sourceparams
 
 
 Indices and tables

docs/source/sourceparams.rst

@@ -0,0 +1,5 @@
+Source parameters
+=================
+
+.. autoenum:: sourcefinder.utility.sourceparams.SourceParams
+   :no-index:

pyproject.toml

@@ -27,6 +27,7 @@ dependencies = [
     "pandas",
     "tables",
     "pytest-cov",
+    'enum-tools[sphinx]',
 ]
 
 [project.optional-dependencies]

sourcefinder/utility/sourceparams.py

@@ -3,6 +3,8 @@
 
 
 class SourceParams(str, Enum):
+    """Enumeration of source parameters that can be measured and stored."""
+
     PEAK = "peak"
     PEAK_ERR = "peak_err"
     FLUX = "flux"
@@ -213,7 +215,7 @@ def describe(self) -> str:
 
 # This should render source parameter descriptions in Sphinx/RTD.
 for member in SourceParams:
-    member.__doc__ = _source_params_descriptions.get(member.value, "")
+    member.__doc__ = SourceParams.describe(member)
 
 # Set default set of source parameters to store in a file, e.g. a .csv file.
 _file_fields = [