Add own section for CustomDist in distributions API

pymc-devs · Jun 24, 2024 · 7af0a87 · 7af0a87
1 parent ae1b7a8
commit 7af0a87
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/docs/source/api/distributions.rst b/docs/source/api/distributions.rst
@@ -14,6 +14,7 @@ Distributions
    distributions/timeseries
    distributions/truncated
    distributions/censored
+   distributions/custom
    distributions/simulator
    distributions/transforms
    distributions/utilities
diff --git a/docs/source/api/distributions/custom.rst b/docs/source/api/distributions/custom.rst
@@ -0,0 +1,20 @@
+**********
+CustomDist
+**********
+
+..
+   Manually follow the template in _templates/distribution.rst.
+   If at any point, multiple objects are listed here,
+   the pattern should instead be modified to that of the
+   other API files such as api/distributions/continuous.rst
+
+.. currentmodule:: pymc
+
+.. autoclass:: CustomDist
+
+   .. rubric:: Methods
+
+   .. autosummary::
+      :toctree: classmethods
+
+      CustomDist.dist
diff --git a/docs/source/api/distributions/utilities.rst b/docs/source/api/distributions/utilities.rst
@@ -7,7 +7,6 @@ Distribution utilities
    :toctree: generated/
 
     Continuous
-    CustomDist
     Discrete
     Distribution
     SymbolicRandomVariable