Skip to content

some doc fixes #6200

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
Oct 11, 2022
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 conda-envs/environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion conda-envs/windows-environment-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 2 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ------------------------------------------------
Expand Down Expand Up @@ -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",
Expand Down
11 changes: 6 additions & 5 deletions docs/source/contributing/build_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down