Skip to content

Commit 9b5aa8e

Browse files
authored
add details for building docs locally (#593)
1 parent 222d60c commit 9b5aa8e

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
11
# Contributing guide
22

33
Page in construction, for now go to https://github.com/pymc-devs/pymc-extras#questions.
4+
5+
## Building the documentation
6+
7+
To build the documentation locally, you need to install the necessary
8+
dependencies and then use `make` to build the HTML files.
9+
10+
First, install the package with the optional documentation dependencies:
11+
12+
```bash
13+
pip install ".[docs]"
14+
```
15+
16+
Then, navigate to the `docs` directory and run `make html`:
17+
18+
```bash
19+
cd docs
20+
make html
21+
```
22+
23+
The generated HTML files will be in the `docs/_build/html` directory. You can
24+
open the `index.html` file in that directory to view the documentation.

0 commit comments

Comments
 (0)