some doc fixes

Author: OriolAbril

conda-envs/environment-dev.yml

@@ -27,7 +27,7 @@ dependencies:
 - myst-nb
 - numpydoc
 - pre-commit>=2.8.0
-- pydata-sphinx-theme<0.10.1
+- pydata-sphinx-theme>=0.11.0
 - pytest-cov>=2.5
 - pytest>=3.0
 - sphinx-copybutton

conda-envs/windows-environment-dev.yml

@@ -25,7 +25,7 @@ dependencies:
 - myst-nb
 - numpydoc
 - pre-commit>=2.8.0
-- pydata-sphinx-theme<0.10.1
+- pydata-sphinx-theme>=0.11.0
 - pytest-cov>=2.5
 - pytest>=3.0
 - sphinx-autobuild>=0.7

docs/source/conf.py

@@ -20,10 +20,6 @@
 import sys
 from pathlib import Path
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath(os.path.join("..", "..")))
 import pymc  # isort:skip
 
 # -- General configuration ------------------------------------------------

docs/source/contributing/build_docs.md

@@ -8,11 +8,12 @@ To build docs on Windows we recommend running inside a Docker container.
 To build the docs, run these commands at PyMC repository root:
 
 ```bash
-$ pip install -r requirements-dev.txt  # Make sure the dev requirements are installed
-$ pip install numpyro  # Make sure `sampling_jax` docs can be built
-$ make clean  # clean built docs from previous runs and intermediate outputs
-$ make html   # Build docs
-$ python -m http.server --directory docs/_build/  # Render docs
+pip install -r requirements-dev.txt  # Make sure the dev requirements are installed
+pip install numpyro  # Make sure `sampling_jax` docs can be built
+pip install -e .  # Install local pymc version as installable package
+make clean  # clean built docs from previous runs and intermediate outputs
+make html   # Build docs
+python -m http.server --directory docs/_build/  # Render docs
 ```
 
 Check the printed URL where docs are being served and open it.

requirements-dev.txt

@@ -17,7 +17,7 @@ numpydoc
 pandas>=0.24.0
 polyagamma
 pre-commit>=2.8.0
-pydata-sphinx-theme<0.10.1
+pydata-sphinx-theme>=0.11.0
 pytest-cov>=2.5
 pytest>=3.0
 scipy>=1.4.1