Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,10 +85,27 @@ The upload to PyPi has to be confirmed by one of the core developers.

First, create an environment that includes the documentation dependencies:


### Conda

Conda installs the required dependencies and pandoc as well:

```bash
conda env create -f environment_docs.yaml
```

### Venv

To use a venv without conda, a system installation of pandoc is required: https://pandoc.org/installing.html

You then need to install the dependencies into your venv using:

```bash
pip install -e .[docs]
```

### Building Docs

To generate or update the automatically created docs in `docs/source/assume*`, run:

```bash
Expand Down