Skip to main content
`Ctrl`+`K`

# Developers Guide

## Running tests

To run tests, run the following command from the SALib project directory.

    $ pytest

## Building documentation locally

Notes here assumes you are at the root of the project directory.

Install dependencies for documentation

    $ pip install -e .[doc]

### On *nix

    $ cd docs
    $ make html

### On Windows

In a command prompt

    > cd docs
    > sphinx-build . ./html

## Prior to submitting a PR

Run the below to catch any formatting issues.

    # pre-commit install

    pre-commit run --all-files