Skip to content

Commit d14daa6

Browse files
authored
docs: Improve CONTRIBUTING.md (#303)
* Improve the section about building the documentation by explaining how to open the built and deployed documentation from a PR
1 parent 0017a56 commit d14daa6

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ with maintainers before implementing major changes.
4747
pdm run pytest tests/unit tests/doc --cov=src
4848
```
4949

50-
## Building the documentation locally
50+
## Building the documentation
51+
52+
### Locally
53+
5154
- From the `docs` folder, run:
5255
```bash
5356
pdm run make html
@@ -59,6 +62,13 @@ with maintainers before implementing major changes.
5962
pdm run make clean
6063
```
6164

65+
### Online
66+
67+
- When you open a pull request, a GitHub action should build and deploy the documentation, which
68+
will become available at `torchjd.org/pr/<pr_number>`. Additionally, you can click on the check
69+
status of the action, then click on `Summary`, and then click on the link of the built
70+
documentation.
71+
6272
## Development guidelines
6373

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

0 commit comments

Comments
 (0)