Skip to content

Commit e78afc0

Browse files
committed
[no ci] docs: avoid explicitly listing modules
1 parent 2e54d34 commit e78afc0

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

docsrc/source/_templates/custom-module-template.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
1+
{% if objname == 'bayesflow' %}
2+
API Reference
3+
=============
4+
5+
This is the reference for the public API. For a more guided introduction,
6+
please refer to the :doc:`Examples <../examples>` section.
7+
8+
{% else %}
19
{{ objname | escape | underline}}
10+
{% endif %}
211

312
.. automodule:: {{ fullname }}
413
:member-order: alphabetical

docsrc/source/api/bayesflow.rst

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,12 @@
11
API Reference
22
=============
33

4-
This is the reference for the public API. For a more guided introduction,
5-
please refer to the :doc:`Examples <../examples>` section.
4+
This page will be overridden by the autosummary call for bayesflow.
5+
To modify the actual output, refer to _templates/custom-module-template.rst.
66

77
.. autosummary::
88
:toctree: .
99
:template: custom-module-template.rst
1010
:recursive:
1111

12-
bayesflow.adapters
13-
bayesflow.approximators
14-
bayesflow.benchmarks
15-
bayesflow.datasets
16-
bayesflow.diagnostics
17-
bayesflow.distributions
18-
bayesflow.experimental
19-
bayesflow.links
20-
bayesflow.metrics
21-
bayesflow.networks
22-
bayesflow.simulators
23-
bayesflow.scores
24-
bayesflow.types
25-
bayesflow.utils
26-
bayesflow.workflows
12+
bayesflow

0 commit comments

Comments
 (0)