Merge pull request #79 from deepskies/docstrings

Path correction to build docs
deepskies · Jun 24, 2024 · 0505569 · 0505569
2 parents 39b1924 + 415a35e
commit 0505569
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/docs/source/data.rst b/docs/source/data.rst
@@ -3,14 +3,14 @@
 Data 
 ======
 
-.. autoclass:: data.data.Data
+.. autoclass:: deepdiagnostics.data.data.Data
     :members:
 
-.. autoclass:: data.H5Data
+.. autoclass:: deepdiagnostics.data.H5Data
     :members:
 
-.. autoclass:: data.PickleData
+.. autoclass:: deepdiagnostics.data.PickleData
     :members:
 
-.. autoclass:: data.simulator.Simulator
+.. autoclass:: deepdiagnostics.data.simulator.Simulator
     :members: 
diff --git a/docs/source/metrics.rst b/docs/source/metrics.rst
@@ -3,18 +3,18 @@
 Metrics
 =========
 
-.. autoclass:: metrics.metric.Metric
+.. autoclass:: deepdiagnostics.metrics.metric.Metric
     :members:
 
-.. autoclass:: metrics.AllSBC
+.. autoclass:: deepdiagnostics.metrics.AllSBC
     :members: calculate
 
-.. autoclass:: metrics.LC2ST
+.. autoclass:: deepdiagnostics.metrics.LC2ST
 
-.. autoclass:: metrics.local_two_sample.LocalTwoSampleTest
+.. autoclass:: deepdiagnostics.metrics.local_two_sample.LocalTwoSampleTest
     :members: calculate 
 
-.. autoclass:: metrics.CoverageFraction
+.. autoclass:: deepdiagnostics.metrics.CoverageFraction
     :members: calculate
 
 .. bibliography:: 
diff --git a/docs/source/models.rst b/docs/source/models.rst
@@ -3,8 +3,8 @@
 Models 
 ========
 
-.. autoclass:: models.model.Model
+.. autoclass:: deepdiagnostics.models.model.Model
     :members:
 
-.. autoclass:: models.SBIModel
+.. autoclass:: deepdiagnostics.models.SBIModel
     :members:
diff --git a/docs/source/plots.rst b/docs/source/plots.rst
@@ -3,31 +3,31 @@
 Plots 
 =======
 
-.. autoclass:: plots.plot.Display
+.. autoclass:: deepdiagnostics.plots.plot.Display
 
-.. autoclass:: plots.CDFRanks
+.. autoclass:: deepdiagnostics.plots.CDFRanks
     :members: plot
 
-.. autoclass:: plots.Ranks
+.. autoclass:: deepdiagnostics.plots.Ranks
     :members: plot
 
-.. autoclass:: plots.CoverageFraction
+.. autoclass:: deepdiagnostics.plots.CoverageFraction
     :members: plot
 
-.. autoclass:: plots.TARP
+.. autoclass:: deepdiagnostics.plots.TARP
     :members: plot
 
-.. autoclass:: plots.LC2ST
-.. autoclass:: plots.local_two_sample.LocalTwoSampleTest
+.. autoclass:: deepdiagnostics.plots.LC2ST
+.. autoclass:: deepdiagnostics.plots.local_two_sample.LocalTwoSampleTest
     :members: plot
 
-.. autoclass:: plots.PPC
+.. autoclass:: deepdiagnostics.plots.PPC
     :members: plot
 
-.. autoclass:: plots.PriorPC
+.. autoclass:: deepdiagnostics.plots.PriorPC
     :members: plot
 
-.. autoclass:: plots.Parity
+.. autoclass:: deepdiagnostics.plots.Parity
     :members: plot
 
 .. bibliography::