Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Contribution docs for documentation #19

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
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
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