File tree Expand file tree Collapse file tree 1 file changed +11
-1
lines changed
Expand file tree Collapse file tree 1 file changed +11
-1
lines changed Original file line number Diff line number Diff 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
6474The following guidelines should help preserve a good code quality in TorchJD. Contributions that do
You can’t perform that action at this time.
0 commit comments