diff --git a/conda-envs/environment-dev.yml b/conda-envs/environment-dev.yml index ca8e044e21..bef8415953 100644 --- a/conda-envs/environment-dev.yml +++ b/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 diff --git a/conda-envs/windows-environment-dev.yml b/conda-envs/windows-environment-dev.yml index bca1a3ab84..7fdf2c6bde 100644 --- a/conda-envs/windows-environment-dev.yml +++ b/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 diff --git a/docs/source/conf.py b/docs/source/conf.py index fea32e009f..99008591a3 100755 --- a/docs/source/conf.py +++ b/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 ------------------------------------------------ @@ -259,8 +255,9 @@ def setup(app): "logo_link": "https://www.pymc.io", "show_prev_next": False, "navbar_start": ["navbar-logo", "navbar-version"], - "navbar_end": ["search-field.html", "navbar-icon-links.html"], + "navbar_end": ["navbar-icon-links.html"], "page_sidebar_items": ["page-toc", "edit-this-page", "donate"], + "header_links_before_dropdown": 6, "search_bar_text": "Search...", "use_edit_page_button": True, "google_analytics_id": "UA-176578023-1", diff --git a/docs/source/contributing/build_docs.md b/docs/source/contributing/build_docs.md index d4a7694aec..09e37328f4 100644 --- a/docs/source/contributing/build_docs.md +++ b/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. diff --git a/requirements-dev.txt b/requirements-dev.txt index b74187f6b8..5255ddfc3d 100644 --- a/requirements-dev.txt +++ b/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