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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,24 @@
# Contributing guide

Page in construction, for now go to https://github.com/pymc-devs/pymc-extras#questions.

## Building the documentation

To build the documentation locally, you need to install the necessary
dependencies and then use `make` to build the HTML files.

First, install the package with the optional documentation dependencies:

```bash
pip install ".[docs]"
```

Then, navigate to the `docs` directory and run `make html`:

```bash
cd docs
make html
```

The generated HTML files will be in the `docs/_build/html` directory. You can
open the `index.html` file in that directory to view the documentation.