API major update

.readthedocs.yaml

@@ -15,4 +15,4 @@ python:
     - method: pip
       path: .
       extra_requirements:
-        - docs
+        - docs

docs/_templates/module.rst

@@ -0,0 +1,5 @@
+{{ fullname }}
+{{ underline }}
+
+.. automodule:: {{ fullname }}
+    :members:

docs/conf.py

@@ -45,19 +45,21 @@
 
 extensions = ['myst_parser', 'sphinx.ext.napoleon', 'sphinx_markdown_tables', 'sphinx.ext.autosectionlabel',
               'sphinx.ext.linkcode', 'sphinx.ext.intersphinx', 'sphinx.ext.autodoc', 'sphinx.ext.autosummary']
+extensions.append('autoapi.extension')
+autoapi_dirs = ['', '../flip']
 
 napoleon_google_docstring = True
 myst_enable_extensions = ["dollarmath"]
 myst_dmath_double_inline = True
 
 autosectionlabel_prefix_document = True
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+autosummary_generate = True
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ['_build', '_templates']
 
 source_suffix = {
     '.rst': 'restructuredtext',

flip/__init__.py

@@ -1,9 +1,11 @@
 """Init file of the flip package."""
+import os
 from . import covariance
 from . import fitter
 from . import gridding
 from . import likelihood
 from . import model_evaluation
 from . import utils
 
-__version__ = "1.0.0"
+__version__ = "1.0.0"
+__flip_dir_path__ =  os.path.dirname(__file__)

setup.cfg

@@ -33,3 +33,4 @@ docs =
     sphinx-design
     sphinx-inline-tabs
     sphinx-tabs
+    sphinx-autoapi