Skip to content

Commit eb0e378

Browse files
authored
Add contributing file
1 parent 943b46e commit eb0e378

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing to this repository
2+
3+
Most of this repository is structured for **Sphinx**, a documentation engine built in Python.
4+
5+
## Build the documentation
6+
7+
The easiest way to build the documentation in this repository is to use `nox`,
8+
a tool for quickly building environments and running commands within them.
9+
Nox ensures that your environment has all the dependencies needed to build the documentation.
10+
11+
To do so, follow these steps:
12+
13+
1. Install `nox`
14+
15+
```
16+
pip install nox
17+
```
18+
2. Build the documentation:
19+
20+
```
21+
nox -s docs_build
22+
```
23+
24+
This should create a local environment in a `.nox` folder, build the documentation (as specified in the `noxfile.py` configuration), and the output will be in `_build/html`.
25+
26+
To build live documentation that updates when you update local files, run the following command:
27+
28+
```
29+
nox -s docs_live
30+
```

0 commit comments

Comments
 (0)