Merge branch 'main' into change-gramian-normalization-to-frobenius-norm

Author: PierreQuinton

.github/workflows/cleanup-pr-docs.yml

@@ -10,7 +10,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - name: Checkout gh-pages branch
+      - name: Checkout TorchJD/documentation main branch
         uses: actions/checkout@v4
         with:
           repository: TorchJD/documentation

CONTRIBUTING.md

@@ -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
@@ -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