ci(docs): Simplify documentation CI (#306)

* Make build-deploy-docs.yml not trigger on PR
* Change Build_and_deploy_doc to run in the prod-documentation environment
* Change Build_and_deploy_doc job name
* Remove cleanup-pr-docs.yml
* Revert "docs: Improve `CONTRIBUTING.md` (#303)"
* Rename main folder to latest in the built documentation repo

Author: ValerianRey

.github/workflows/build-deploy-docs.yml

@@ -5,11 +5,11 @@ on:
     branches: [ main ]
     tags:
       - 'v[0-9]*.[0-9]*.[0-9]*'
-  pull_request:
-    types: [opened, synchronize, reopened]
 
 jobs:
-  Build_and_deploy_doc:
+  build-deploy-doc:
+    name: Build & deploy doc
+    environment: prod-documentation
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -33,21 +33,18 @@ jobs:
         id: deploy_folder
         run: |
           echo "Determining deployment folder..."
-          if [ "${{ github.event_name }}" = "pull_request" ]; then
-            echo "Deploying to target pr/${{ github.event.number }}"
-            echo "DEPLOY_DIR=pr/${{ github.event.number }}" >> $GITHUB_OUTPUT
-          elif [[ "${{ github.ref }}" == refs/tags/* ]]; then
+          if [[ "${{ github.ref }}" == refs/tags/* ]]; then
             echo "Deploying to target ${{ github.ref_name }}"
             echo "DEPLOY_DIR=${{ github.ref_name }}" >> $GITHUB_OUTPUT
           else
-            echo "Deploying to target main"
-            echo "DEPLOY_DIR=main" >> $GITHUB_OUTPUT
+            echo "Deploying to target latest"
+            echo "DEPLOY_DIR=latest" >> $GITHUB_OUTPUT
           fi
 
       - name: Deploy to DEPLOY_DIR of TorchJD/documentation
         uses: peaceiris/actions-gh-pages@v4
         with:
-          deploy_key: ${{ secrets.DOCUMENTATION_DEPLOY_KEY }}
+          deploy_key: ${{ secrets.PROD_DOCUMENTATION_DEPLOY_KEY }}
           publish_dir: docs/build/dirhtml
           destination_dir: ${{ steps.deploy_folder.outputs.DEPLOY_DIR }}
           external_repository: TorchJD/documentation
@@ -57,7 +54,7 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/')
         uses: peaceiris/actions-gh-pages@v4
         with:
-          deploy_key: ${{ secrets.DOCUMENTATION_DEPLOY_KEY }}
+          deploy_key: ${{ secrets.PROD_DOCUMENTATION_DEPLOY_KEY }}
           publish_dir: docs/build/dirhtml
           destination_dir: stable
           external_repository: TorchJD/documentation

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

@@ -47,10 +47,7 @@ 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
@@ -62,13 +59,6 @@ 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