Skip to content

Fixup all non-theano non-notebook docs warnings, replace dead link #4300

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 8, 2020
Merged

Fixup all non-theano non-notebook docs warnings, replace dead link #4300

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/source/Advanced_usage_of_Theano_in_PyMC3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_referenced in docs/source/notebooks/table_of_contents_tutorials.js

=================================
Advanced usage of Theano in PyMC3
=================================
Expand Down
5 changes: 5 additions & 0 deletions docs/source/Gaussian_Processes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_href from docs/source/index.rst
Comment on lines +1 to +4
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

otherwise Sphinx throws the "not included in any toctree!" warning


******************
Gaussian Processes
******************
Expand Down
5 changes: 5 additions & 0 deletions docs/source/Probability_Distributions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_href from docs/source/index.rst

.. _prob_dists:

**********************************
Expand Down
5 changes: 5 additions & 0 deletions docs/source/PyMC3_and_Theano.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_href from docs/source/index.rst

================
PyMC3 and Theano
================
Expand Down
5 changes: 5 additions & 0 deletions docs/source/about.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_href from docs/source/index.rst

.. _about:

***********
Expand Down
5 changes: 5 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_"api" is referenced in html_theme_options docs/source/conf.py

.. _api:

***************
Expand Down
5 changes: 5 additions & 0 deletions docs/source/developer_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_referenced in html_theme_options docs/source/conf.py

=====================
PyMC3 Developer Guide
=====================
Expand Down
14 changes: 8 additions & 6 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@

X, y = linear_training_data()
with pm.Model() as linear_model:
weights = pm.Normal('weights', mu=0, sigma=1)
noise = pm.Gamma('noise', alpha=2, beta=1)
y_observed = pm.Normal('y_observed',
mu=X @ weights,
sigma=noise,
observed=y)
weights = pm.Normal("weights", mu=0, sigma=1)
noise = pm.Gamma("noise", alpha=2, beta=1)
y_observed = pm.Normal(
"y_observed",
mu=X @ weights,
sigma=noise,
observed=y,
)
Comment on lines -26 to +33
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this doesn't actually throw a warning or anything, the indentation just looks a bit strange to me


prior = pm.sample_prior_predictive()
posterior = pm.sample()
Expand Down
7 changes: 6 additions & 1 deletion docs/source/learn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
:orphan:

..
_"learn" is referenced in html_theme_options docs/source/conf.py

.. title:: Learning Resources

.. raw:: html
Expand Down Expand Up @@ -99,7 +104,7 @@

<div class="card">
<div class="image">
<img src="https://lh5.googleusercontent.com/R1T8ZXbMi4vSO0JlnLQMkEQNvd2ncBb23OmHOsmw-t_oEOF6jJlfWuJoOK0MMmECSDymhUdfTS2yoMgkR2TY-xIiBTHCpeuYjzXqD3xhZ-MuIhs2ARcJ=w1280">
<img src="https://lh5.googleusercontent.com/Ms2ssellxl7cM6OEL_kpiKRojcj2E4ZaUWDXOa8zEwi-v9orJGYuhjczbwFSDJNsEb_ruiwtCJONNjoo7T1c7qorZm3LsAnroMAm4S5WzNT_PVqWz9aE=w1280">
Comment on lines -102 to +107
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replaces dead link

</div>
<div class="content">
<div class="header">Doing Bayesian Data Analysis</div>
Expand Down
5 changes: 5 additions & 0 deletions docs/source/sphinxext/gallery_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@
TABLE_OF_CONTENTS_FILENAME = "table_of_contents_{}.js"

INDEX_TEMPLATE = """
:orphan:

..
_href from docs/source/conf.py

.. _{sphinx_tag}:

.. title:: {gallery}_notebooks
Expand Down