From a5a2603b8d1e2f4527ceebab9b8f69e9c89eac78 Mon Sep 17 00:00:00 2001 From: Will Dean Date: Tue, 7 Oct 2025 22:48:11 -0400 Subject: [PATCH] add details for building docs locally --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7fcb915e0..c95c73bc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,24 @@ # Contributing guide Page in construction, for now go to https://github.com/pymc-devs/pymc-extras#questions. + +## Building the documentation + +To build the documentation locally, you need to install the necessary +dependencies and then use `make` to build the HTML files. + +First, install the package with the optional documentation dependencies: + +```bash +pip install ".[docs]" +``` + +Then, navigate to the `docs` directory and run `make html`: + +```bash +cd docs +make html +``` + +The generated HTML files will be in the `docs/_build/html` directory. You can +open the `index.html` file in that directory to view the documentation.