Skip to content

Commit 2367a21

Browse files
committed
doc wip: update content
1 parent c91ac4c commit 2367a21

File tree

4 files changed

+15
-14
lines changed

4 files changed

+15
-14
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The documentation uses [sphinx](https://www.sphinx-doc.org/) and relies on [nump
141141
You need to install the following python packages for setting up documentation generation:
142142

143143
```
144-
pip install sphinx numpydoc myst-nb sphinx_design sphinx-book-theme
144+
pip install sphinx numpydoc myst-nb sphinx_design sphinx-book-theme sphinxcontrib-bibtex
145145
```
146146

147147
The overall *structure* of the documentation is manually designed. This also applies to the API documentation. This has two implications for you:

docsrc/source/api/bayesflow.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,17 @@ Autosummary
1111
:template: custom-module-template.rst
1212
:recursive:
1313

14+
bayesflow.adapters
1415
bayesflow.approximators
1516
bayesflow.benchmarks
16-
bayesflow.configurators
1717
bayesflow.datasets
1818
bayesflow.diagnostics
1919
bayesflow.distributions
2020
bayesflow.metrics
2121
bayesflow.networks
2222
bayesflow.simulators
23+
bayesflow.types
24+
bayesflow.utils
2325

2426

2527
Submodules
@@ -28,15 +30,17 @@ Submodules
2830
.. toctree::
2931
:maxdepth: 2
3032

33+
bayesflow.adapters
3134
bayesflow.approximators
3235
bayesflow.benchmarks
33-
bayesflow.configurators
3436
bayesflow.datasets
3537
bayesflow.diagnostics
3638
bayesflow.distributions
3739
bayesflow.metrics
3840
bayesflow.networks
3941
bayesflow.simulators
42+
bayesflow.types
43+
bayesflow.utils
4044

4145
Miscellaneous
4246
-------------
@@ -49,4 +53,4 @@ Miscellaneous
4953
I added a citation here to test the bibtex extension, :cite:t:`radev2023bayesflow`.
5054

5155
```{bibliography}
52-
```
56+
```

docsrc/source/examples.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,9 @@ The corresponding Jupyter Notebooks are available :mainbranch:`here <examples/>`
1010
:glob:
1111
:numbered:
1212

13-
_examples/Intro_Amortized_Posterior_Estimation.ipynb
14-
_examples/TwoMoons_Bimodal_Posterior.ipynb
15-
_examples/Model_Misspecification.ipynb
16-
_examples/LCA_Model_Posterior_Estimation.ipynb
17-
_examples/Linear_ODE_system.ipynb
18-
_examples/Covid19_Initial_Posterior_Estimation.ipynb
19-
_examples/Model_Comparison_MPT.ipynb
20-
_examples/Hierarchical_Model_Comparison_MPT.ipynb
13+
_examples/Quickstart_Amortized_Posterior_Estimation.ipynb
14+
_examples/TwoMoons_StarterNotebook.ipynb
15+
_examples/SIR_PosteriorEstimation.ipynb
16+
_examples/Linear_Regression.ipynb
17+
_examples/Hyperparameter_Optimization.ipynb
18+
_examples/Bayesian_Experimental_Design.ipynb

docsrc/source/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ BayesFlow requires Python version 3.9 or later.
4040
The installer should automatically choose the appropriate TensorFlow version depending on your operating system.
4141
However, if the installation fails, Tensorflow and Tensorflow-Probability are likely to be the culprit,
4242
and you might consider starting your bug hunt there.
43-
You can find detailed installation instructions for developers :doc:`here <installation>`.
43+
You can find detailed installation instructions for developers :doc:`here <contributing>`.
4444

4545

4646
Citation
@@ -120,6 +120,5 @@ Indices
120120
self
121121
examples
122122
api/bayesflow
123-
installation
124123
contributing
125124
about

0 commit comments

Comments
 (0)