Skip to content

Commit

Permalink
Add contributing file
Browse files Browse the repository at this point in the history
  • Loading branch information
lwasser authored Oct 24, 2022
1 parent 943b46e commit eb0e378
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
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
```

0 comments on commit eb0e378

Please sign in to comment.