Skip to content

Commit dba868a

Browse files
committed
update object usage index
1 parent 33fca8e commit dba868a

File tree

7 files changed

+60
-41
lines changed

7 files changed

+60
-41
lines changed

examples/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
# "sidebar-nav-bs.html",
101101
"postcard_categories.html",
102102
"tagcloud.html",
103+
"sidebar-ethical-ads.html",
103104
],
104105
}
105106

examples/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,5 +76,5 @@ has tags in its metadata they are listed on the right sidebar after the {fas}`ta
7676
:hidden:
7777

7878
blog
79-
object_index
79+
object_index/index
8080
:::
+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
-------------
2+
Distributions
3+
-------------
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
8+
distributions/continuous
9+
distributions/discrete
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Continuous
2+
**********
3+
4+
.. autolink-examples:: pymc.Beta
5+
:type: class
6+
:collapse:
7+
8+
.. autolink-examples:: pymc.Exponential
9+
:type: class
10+
:collapse:
11+
12+
.. autolink-examples:: pymc.Normal
13+
:type: class
14+
:collapse:
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Discrete
2+
********
3+
4+
.. autolink-examples:: pymc.Poisson
5+
:type: class
6+
:collapse:

examples/object_index/index.rst

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
================
2+
Object use index
3+
================
4+
5+
This page is structured like the {ref}`PyMC API Reference page <pymc:api>` and
6+
for each function in the API it lists all the examples where that PyMC object
7+
is used.
8+
9+
.. warning::
10+
11+
This page is still a proof of concept only. See
12+
`pymc-examples#289 <https://github.com/pymc-devs/pymc-examples/issues/289>`_
13+
for more details.
14+
15+
.. toctree::
16+
:maxdepth: 2
17+
18+
distributions
19+
samplers
20+
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,17 @@
1-
================
2-
Object use index
3-
================
4-
5-
-------------
6-
Distributions
7-
-------------
8-
9-
Continuous
10-
**********
11-
12-
.. autolink-examples:: pymc.Beta
13-
:type: class
14-
:collapse:
1+
------------------
2+
Sampling functions
3+
------------------
154

16-
.. autolink-examples:: pymc.Exponential
17-
:type: class
5+
.. autolink-examples:: pymc.sample
6+
:type: func
187
:collapse:
198

20-
.. autolink-examples:: pymc.Normal
21-
:type: class
9+
.. autolink-examples:: pymc.sample_posterior_predictive
10+
:type: func
2211
:collapse:
2312

24-
25-
Discrete
26-
********
27-
28-
.. autolink-examples:: pymc.Poisson
29-
:type: class
13+
.. autolink-examples:: pymc.sample_prior_predictive
14+
:type: func
3015
:collapse:
3116

3217
--------
@@ -44,19 +29,3 @@ Samplers
4429
.. autolink-examples:: pymc.Slice
4530
:type: class
4631
:collapse:
47-
48-
------------------
49-
Sampling functions
50-
------------------
51-
52-
.. autolink-examples:: pymc.sample
53-
:type: func
54-
:collapse:
55-
56-
.. autolink-examples:: pymc.sample_posterior_predictive
57-
:type: func
58-
:collapse:
59-
60-
.. autolink-examples:: pymc.sample_prior_predictive
61-
:type: func
62-
:collapse:

0 commit comments

Comments
 (0)