Skip to content

Commit

Permalink
Update Contribution docs for documentation (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
tcmetzger authored Mar 27, 2024
1 parent d6abbba commit d2c731e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ sphinx:
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt
- requirements: docs/requirements-docs.txt
17 changes: 13 additions & 4 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,27 @@ Please file an issue on the [Github page](https://github.com/earth-system-radiat

## Would you like to set up a local development environment?

Please use the file `environment.yml` to create a conda environment with all the necessary dependencies:
Please follow the instructions for installing pyRTE-RRTMTP with pip in the [README](README.md).

## Would you like to contribute to the documentation?

The documentation uses [Sphinx](https://www.sphinx-doc.org/en/master/) and is located in the `docs` directory.

To build the documentation locally, first install the required documentation dependencies (optimally in a dedicated virtual environment):

```bash
conda env create -f environment.yml
pip install -r docs/requirements-doc.txt
```

After creating the environment, activate it with:
Then, build the documentation:

```bash
conda activate pyrte-rrtmtp
cd docs
make html
```

The built documentation will be located in `docs/build/html`.

## Did you write a patch that fixes a bug?

Please fork this repository, branch from `develop`, make your changes, and open a
Expand Down

0 comments on commit d2c731e

Please sign in to comment.