Skip to content

Build docs in simplified environment #6537

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.

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 3 commits into from
Feb 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ python:
path: .

conda:
environment: "conda-envs/environment-dev.yml"
environment: "conda-envs/environment-docs.yml"

build:
os: "ubuntu-20.04"
Expand Down
3 changes: 0 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,6 @@ clean:
rm -rf $(SOURCEDIR)/api/generated
rm -rf $(SOURCEDIR)/api/**/generated
rm -rf $(SOURCEDIR)/api/**/classmethods
rm -rf $(SOURCEDIR)/contributing/private_api/generated
rm -rf $(SOURCEDIR)/contributing/private_api/**/generated
rm -rf $(SOURCEDIR)/contributing/private_api/**/classmethods
rm -rf docs/jupyter_execute

html:
Expand Down
35 changes: 35 additions & 0 deletions conda-envs/environment-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# "dev" conda envs are to be used by devs in setting their local environments
name: pymc-docs
channels:
- conda-forge
- defaults
dependencies:
# Base dependencies
- arviz>=0.13.0
- cachetools>=4.2.1
- cloudpickle
- fastprogress>=0.2.0
- numpy>=1.15.0
- pandas>=0.24.0
- pip
- pytensor=2.9.1
- python-graphviz
- scipy>=1.4.1
- typing-extensions>=3.7.4
# Extra dependencies for docs build
- ipython>=7.16
- jax
- jupyter-sphinx
- myst-nb
- numpydoc
- pre-commit>=2.8.0
- sphinx-copybutton
- sphinx-design
- sphinx-notfound-page
- sphinx>=1.5
- sphinxext-rediraffe
- watermark
- sphinx-remove-toctrees
- pip:
- git+https://github.com/pymc-devs/pymc-sphinx-theme
- numdifftools>=0.9.40
1 change: 0 additions & 1 deletion docs/source/api/backends.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,5 @@ Internal structures
:toctree: generated/

NDArray
point_list_to_multitrace
base.BaseTrace
base.MultiTrace
1 change: 0 additions & 1 deletion docs/source/api/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ Data
Data
GeneratorAdapter
Minibatch
align_minibatches
2 changes: 0 additions & 2 deletions docs/source/api/distributions/simulator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@ Simulator
.. autosummary::
:toctree: generated

SimulatorRV
Simulator
KullbackLiebler
1 change: 0 additions & 1 deletion docs/source/api/distributions/timeseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Timeseries
.. autosummary::
:toctree: generated

AR1
AR
GaussianRandomWalk
GARCH11
Expand Down
2 changes: 0 additions & 2 deletions docs/source/api/distributions/transforms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Transform instances are the entities that should be used in the
simplex
logodds
log_exp_m1
ordered_univariate
ordered_multivariate
log
sum_to_1
circular
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/math.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Functions exposed in pymc.math
where
and_
or_
abs_
abs
exp
log
cos
Expand Down
4 changes: 1 addition & 3 deletions docs/source/api/pytensorf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,4 @@ PyTensor utils
join_nonshared_inputs
make_shared_replacements
generator
set_at_rng
at_rng
pandas_to_array
convert_observed_data
1 change: 0 additions & 1 deletion docs/source/api/samplers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ This submodule contains functions for MCMC and forward sampling.
sample_posterior_predictive_w
sampling.jax.sample_blackjax_nuts
sampling.jax.sample_numpyro_nuts
iter_sample
init_nuts
draw

Expand Down
2 changes: 0 additions & 2 deletions docs/source/api/vi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Variational Inference

ADVI
ASVGD
NFVI
SVGD
FullRankADVI
ImplicitGradient
Expand All @@ -26,7 +25,6 @@ Approximations
Empirical
FullRank
MeanField
NormalizingFlow
sample_approx

OPVI
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# configure notfound extension to not add any prefix to the urls
notfound_urls_prefix = "/projects/docs/en/latest/"
Expand Down
1 change: 0 additions & 1 deletion docs/source/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ review_pr_pymc_examples
:maxdepth: 1
:caption: Reference content

private_api/index
python_style
jupyter_style
pr_checklist
Expand Down
17 changes: 0 additions & 17 deletions docs/source/contributing/private_api/index.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/source/contributing/private_api/tests.rst

This file was deleted.