-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Contributing to this repository | ||
|
||
Most of this repository is structured for **Sphinx**, a documentation engine built in Python. | ||
|
||
## Build the documentation | ||
|
||
The easiest way to build the documentation in this repository is to use `nox`, | ||
a tool for quickly building environments and running commands within them. | ||
Nox ensures that your environment has all the dependencies needed to build the documentation. | ||
|
||
To do so, follow these steps: | ||
|
||
1. Install `nox` | ||
|
||
``` | ||
pip install nox | ||
``` | ||
2. Build the documentation: | ||
|
||
``` | ||
nox -s docs_build | ||
``` | ||
|
||
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`. | ||
|
||
To build live documentation that updates when you update local files, run the following command: | ||
|
||
``` | ||
nox -s docs_live | ||
``` |