Skip to content

Commit a3dc49d

Browse files
committed
docs: contributing update
1 parent 82e2cda commit a3dc49d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,34 @@ pre-commit install
3232

3333
Committing will now automatically run the local hooks and ensure that your commit passes all lint checks.
3434

35+
## Running the docs locally
36+
37+
First, make sure you have the docs-related tooling installed:
38+
39+
```bash
40+
pip install -e .'[doc]'
41+
```
42+
43+
Then, run the following from the root project directory:
44+
45+
```bash
46+
sphinx-ape build .
47+
```
48+
49+
For the best viewing experience, use a local server:
50+
51+
```bash
52+
sphinx-ape serve .
53+
```
54+
55+
Then, open your browser to `127.0.0.1:1337` and click the `ape` directory link.
56+
57+
You can also use the `--open` flag to automatically open the docs:
58+
59+
```bash
60+
sphinx-ape serve . --open
61+
```
62+
3563
## Pull Requests
3664

3765
Pull requests are welcomed! Please adhere to the following:

0 commit comments

Comments
 (0)