Skip to content

Improve CONTRIBUTING.md #303

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.

Sign up for GitHub

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

Merged
ValerianRey merged 1 commit into from
Apr 6, 2025
Merged

Improve CONTRIBUTING.md #303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ with maintainers before implementing major changes.
pdm run pytest tests/unit tests/doc --cov=src
```

## Building the documentation locally
## Building the documentation

### Locally

- From the `docs` folder, run:
```bash
pdm run make html
Expand All @@ -59,6 +62,13 @@ with maintainers before implementing major changes.
pdm run make clean
```

### Online

- When you open a pull request, a GitHub action should build and deploy the documentation, which
will become available at `torchjd.org/pr/<pr_number>`. Additionally, you can click on the check
status of the action, then click on `Summary`, and then click on the link of the built
documentation.

## Development guidelines

The following guidelines should help preserve a good code quality in TorchJD. Contributions that do
Expand Down