misc changes

BDNYC · Jul 1, 2024 · 7946613 · 7946613
1 parent 3fc1447
commit 7946613
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 10 deletions.
diff --git a/Doublet_Quantifier/curvefit.py b/Doublet_Quantifier/curvefit.py
@@ -263,6 +263,7 @@ def two_curve_bounds(spec, cont, dip, continuum="linear", mus=None):
     ]
 
 
+    # needs editing copied from single function prior to further editing
 def fit_two_curves(
     spec,
     cont,
@@ -274,7 +275,6 @@ def fit_two_curves(
     bin_size=10,
     bin_take="max",
 ):
-    # needs editing copied from single function prior to further editing
     """
     spec (array-like): spectrum
     function (string): takes "gaussian", "voigt", or "pseudo-Voigt" as function to be fit to the spectrum

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,19 +7,28 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'Doublet_Quantifier'
-copyright = '2024, Alexandra Baldelli'
+copyright = '0.0.1, Alexandra Baldelli'
 author = 'Alexandra Baldelli'
 release = '0.0.1'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.napoleon',
-              'sphinx.ext.intersphinx',
-              'sphinx.ext.mathjax']
+extensions = [
+    'sphinx.ext.napoleon',
+    'myst_parser',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.intersphinx',
+]
 
 templates_path = ['_templates']
 exclude_patterns = []
+
+autodoc_default_options = {
+    'members': True,
+}
+autoclass_content = 'class'
 napoleon_google_docstring = False
 napoleon_numpy_docstring = True
 

diff --git a/docs/source/continuum.rst b/docs/source/continuum.rst
@@ -0,0 +1,5 @@
+====
+continuum
+====
+
+.. automodule:: Doublet_Quantifier.continuum
diff --git a/docs/source/curvefit.rst b/docs/source/curvefit.rst
@@ -0,0 +1,5 @@
+====
+curvefit
+====
+
+.. automodule:: Doublet_Quantifier.curvefit
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,15 +6,22 @@
 Welcome to Doublet_Quantifier's documentation!
 ==============================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+.. toctree:: curvefit
+   :maxdepth: 1
+   :caption: API documentation:
+   curvefit
 
-.. toctree::
+.. toctree:: continuum
    :maxdepth: 1
    :caption: API documentation:
    continuum
-   curvefit
+
+.. toctree:: models
+   :maxdepth: 1
+   :caption: API documentation:
+   models
+
+
 
 
 Indices and tables

diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -0,0 +1,5 @@
+====
+models
+====
+
+.. automodule:: Doublet_Quantifier.models