Skip to content

Commit

Permalink
document classes properly (#233)
Browse files Browse the repository at this point in the history
  • Loading branch information
LegrandNico authored Sep 11, 2024
1 parent c21759b commit 1d57076
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ embedded in models using PyMC>=5.0.0.

.. autosummary::
:toctree: generated/pyhgf.distribution
:nosignatures:

logp
hgf_logp
Expand All @@ -214,8 +215,10 @@ and creates a standard node structure for these models.

.. autosummary::
:toctree: generated/pyhgf.model
:nosignatures:

HGF
Network

Plots
*****
Expand Down
1 change: 0 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"myst_nb",
"sphinxcontrib.bibtex",
"sphinx_togglebutton",
"sphinx_design",
"sphinx_exercise",
]

Expand Down
1 change: 0 additions & 1 deletion requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ watermark
systole>=0.3.0
sphinx-togglebutton
sphinx-design
ipywidgets
sphinx-exercise
1 change: 1 addition & 0 deletions src/pyhgf/distribution.py
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,7 @@ class HGFDistribution(Op):
Print a summary of the results using Arviz
>>> az.summary(idata, var_names="ω_2")
=== ======= ===== ======= ======= ========= ======= ======== ======== =====
.. mean sd hdi_3% hdi_97% mcse_mean mcse_sd ess_bulk ess_tail r_hat
=== ======= ===== ======= ======= ========= ======= ======== ======== =====
Expand Down

0 comments on commit 1d57076

Please sign in to comment.