Skip to content

Commit 667d83b

Browse files
OriolAbrilmartinacantaro
OriolAbril
authored and
martinacantaro
committed
example doc restructure
working and hopefully illustrative doc skeleton update requirements WIP Change log: - Upload new PyMC logo - Updated conf.py to pymc instead of pymc3 - Start configuring and populating index page - Start configuring and populating learning page - Start configuring and populating api page - Updated API to follow the docs/Architecture.png layout - Start configuring and populating learning page - Fix typo in filename of "index legacy" add community page, other minor changes Continue restructuring the API Delete conflicting files example doc restructure update requirements update requirements and gitignore some fixes add changes introduced by pre-commit checks fix community page title update api for distributions update gaussian process api fix end of file more changes sponsor logos sponsor logos cleanup, other changes
1 parent f184912 commit 667d83b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+446
-1444
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ tags
1717

1818
# Sphinx
1919
_build
20+
docs/jupyter_execute
2021

2122
# Merge tool
2223
*.orig

‎.gitmodules

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎docs/logos/sponsors/numfocus.png

41.4 KB
Loading

‎docs/pymc-labs-logo.png renamed to ‎docs/logos/sponsors/pymc-labs.png

File renamed without changes.

‎docs/pymc_logo.jpg

-82.9 KB
Binary file not shown.

‎docs/source/_templates/footer.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<footer class="footer mt-5 mt-md-0">
2+
<div class="container">
3+
{% for footer_item in theme_footer_items %}
4+
<div class="footer-item">
5+
{% include footer_item %}
6+
</div>
7+
{% endfor %}
8+
</div>
9+
</footer>

‎docs/source/_templates/layout.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,25 @@
22

33
<!-- Hide left sidebar in home page -->
44
{% block docs_sidebar %}
5-
{% if pagename != 'index' %}
6-
{{ super() }}
7-
{% endif %}
5+
{% if pagename != 'index' %}
6+
{{ super() }}
7+
{% endif %}
88
{% endblock %}
99

1010
<!-- Hide right sidebar in home page -->
1111
{% block docs_toc %}
12-
{% if pagename != 'index' %}
13-
{{ super() }}
14-
{% endif %}
12+
{% if pagename != 'index' %}
13+
{{ super() }}
14+
{% endif %}
1515
{% endblock %}
1616

1717
<!-- Make body have full width in home page -->
1818
{% block docs_main %}
19-
{% if pagename == 'index' %}
20-
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
21-
{% block body %} {% endblock %}
22-
</main>
23-
{% else %}
24-
{{ super() }}
25-
{% endif %}
19+
{% if pagename == 'index' %}
20+
<main class="col-12 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
21+
{% block body %} {% endblock %}
22+
</main>
23+
{% else %}
24+
{{ super() }}
25+
{% endif %}
2626
{% endblock %}

‎docs/source/about.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
:orphan:
2-
3-
..
4-
_href from docs/source/index.rst
5-
61
.. _about:
72

83
**********

‎docs/source/api.rst

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
:orphan:
2-
3-
..
4-
_"api" is referenced in html_theme_options docs/source/conf.py
5-
61
.. _api:
72

83
*************
@@ -13,20 +8,14 @@ API Reference
138
:maxdepth: 2
149

1510
api/distributions
16-
api/bounds
17-
api/inference
18-
api/glm
1911
api/gp
20-
api/plots
21-
api/stats
22-
api/backends
23-
api/math
24-
api/data
2512
api/model
26-
api/model_graph
27-
api/variables
28-
api/shape_utils
2913
api/ode
14+
api/samplers
15+
api/smc
16+
api/step_methods
17+
api/inference
18+
api/plots
3019

3120
Indices and tables
3221
===================

‎docs/source/api/backends.rst

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎docs/source/api/bounds.rst

Lines changed: 0 additions & 57 deletions
This file was deleted.

‎docs/source/api/data.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/source/api/distributions.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Distributions
66

77
distributions/continuous
88
distributions/discrete
9+
distributions/logprob
910
distributions/multivariate
1011
distributions/mixture
1112
distributions/simulator

‎docs/source/api/distributions/continuous.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,33 @@ Continuous
1010
HalfFlat
1111
Normal
1212
TruncatedNormal
13-
HalfNormal
14-
SkewNormal
1513
Beta
1614
Kumaraswamy
1715
Exponential
1816
Laplace
19-
AsymmetricLaplace
2017
StudentT
21-
HalfStudentT
2218
Cauchy
2319
HalfCauchy
2420
Gamma
25-
InverseGamma
2621
Weibull
22+
HalfStudentT
2723
LogNormal
2824
ChiSquared
25+
HalfNormal
2926
Wald
3027
Pareto
28+
InverseGamma
3129
ExGaussian
3230
VonMises
31+
SkewNormal
3332
Triangular
3433
Gumbel
35-
Rice
3634
Logistic
3735
LogitNormal
3836
Interpolated
37+
Rice
38+
Moyal
39+
AsymmetricLaplace
3940
PolyaGamma
4041

4142
.. automodule:: pymc.distributions.continuous

‎docs/source/api/distributions/discrete.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ Discrete
66
.. autosummary::
77

88
Binomial
9-
ZeroInflatedBinomial
109
BetaBinomial
1110
Bernoulli
11+
DiscreteWeibull
1212
Poisson
13-
ZeroInflatedPoisson
1413
NegativeBinomial
14+
Constant
15+
ZeroInflatedPoisson
16+
ZeroInflatedBinomial
1517
ZeroInflatedNegativeBinomial
1618
DiscreteUniform
1719
Geometric
1820
HyperGeometric
1921
Categorical
20-
DiscreteWeibull
21-
Constant
2222
OrderedLogistic
2323
OrderedProbit
2424

‎docs/source/api/distributions/multivariate.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,17 @@ Multivariate
66
.. autosummary::
77

88
MvNormal
9-
MatrixNormal
10-
KroneckerNormal
119
MvStudentT
12-
Wishart
13-
LKJCholeskyCov
14-
LKJCorr
15-
Multinomial
16-
OrderedMultinomial
1710
Dirichlet
11+
Multinomial
1812
DirichletMultinomial
13+
OrderedMultinomial
14+
Wishart
15+
WishartBartlett
16+
LKJCorr
17+
LKJCholeskyCov
18+
MatrixNormal
19+
KroneckerNormal
1920
CAR
2021

2122
.. automodule:: pymc.distributions.multivariate

‎docs/source/api/distributions/simulator.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ Simulator
55
.. currentmodule:: pymc.distributions.simulator
66
.. autosummary::
77

8+
SimulatorRV
89
Simulator
10+
KullbackLiebler
911

1012
.. automodule:: pymc.distributions.simulator
1113
:members:

‎docs/source/api/distributions/transforms.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
****************************************************************
2-
Transformations of a random variable from one space to another.
2+
Transformations of a random variable from one space to another
33
****************************************************************
44

55
Note that for convenience these entities can be addressed as
66
``pm.transforms.``\ *X* for any name *X*, although they are actually
7-
implemented as ``pm.distributions.transforms.``\*X*.
7+
implemented as ``pm.distributions.transforms.``\ *X*.
88

99
.. currentmodule:: pymc.distributions.transforms
1010

@@ -14,13 +14,11 @@ implemented as ``pm.distributions.transforms.``\*X*.
1414
..
1515
.. autosummary::
1616
17-
transform
17+
Transform
1818
stick_breaking
1919
logodds
2020
interval
2121
log_exp_m1
22-
lowerbound
23-
upperbound
2422
ordered
2523
log
2624
sum_to_1

‎docs/source/api/distributions/utilities.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Distribution utility classes and functions
1111
NoDistribution
1212
DensityDist
1313

14-
1514
.. autoclass:: Distribution
1615
.. autoclass:: Discrete
1716
.. autoclass:: Continuous

‎docs/source/api/glm.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
*************************
2-
Generalized Linear Models
3-
*************************
1+
********************************
2+
Generalized Linear Models (GLMs)
3+
********************************
44

55
.. currentmodule:: pymc.glm.linear
66

‎docs/source/api/gp/cov.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@ Covariance Functions
44

55
.. currentmodule:: pymc.gp.cov
66
.. autosummary::
7-
Constant
8-
WhiteNoise
9-
ExpQuad
10-
RatQuad
11-
Matern32
12-
Matern52
13-
Exponential
14-
Cosine
15-
Periodic
16-
Linear
17-
Polynomial
18-
WarpedInput
19-
Gibbs
20-
Kron
21-
Coregion
7+
Constant
8+
WhiteNoise
9+
ExpQuad
10+
RatQuad
11+
Exponential
12+
Matern52
13+
Matern32
14+
Linear
15+
Polynomial
16+
Cosine
17+
Periodic
18+
WarpedInput
19+
Gibbs
20+
Coregion
21+
ScaledCov
22+
Kron
2223

2324
.. automodule:: pymc.gp.cov
2425
:members:

0 commit comments

Comments
 (0)