remove circle ci + add pr docs predisplay (deepinv#607)

tachella · web-flow · commit 98c5df062cf0 · 2025-07-16T13:15:24.000+02:00
* remove circle ci + modify docs push

* hai comments + contributing guidelines

* fix yaml

* edit if message exists

* yaml refix

* prpreview cleanup

* try sth

* fix

* fix again

* fix

* try sth 2

* fix again

* try

* and now

* ahhh

* add permission

* fix link

* fix link

* move to end

* add tip
diff --git a/.circleci/config.yml b/.circleci/config.yml
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -3,6 +3,9 @@ Thank you for contributing to DeepInverse!
 
 Please refer to our [contributing guidelines](https://deepinv.github.io/deepinv/contributing.html) for full instructions on how to contribute, including writing tests, documentation and code style.
 
+Once the GitHub tests have been approved by a maintainer (only required for first-time contributors), and the `Build Docs` GitHub action
+has run successfully, you can check the generated docs online at https://deepinv.github.io/deepinv/pr-preview/pr-N/ where `N` is the PR number.
+
 ### Checks to be done before submitting your PR
 
 - [ ] `python3 -m pytest deepinv/tests` runs successfully.
diff --git a/.github/workflows/cleanup_docs.yml b/.github/workflows/cleanup_docs.yml
@@ -0,0 +1,34 @@
+name: Cleanup PR Docs on Close
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout gh-pages branch
+      uses: actions/checkout@v3
+      with:
+        ref: gh-pages
+        persist-credentials: true
+
+    - name: Remove PR folder
+      run: |
+        PR_DIR="pr-preview/pr-${{ github.event.pull_request.number }}"
+        if [ -d "$PR_DIR" ]; then
+          rm -rf "$PR_DIR"
+          echo "Removed $PR_DIR"
+        else
+          echo "No preview folder to remove."
+        fi
+
+    - name: Commit and push
+      run: |
+        git config user.name "github-actions"
+        git config user.email "github-actions@github.com"
+        git add -A
+        git commit -m "Clean up docs for PR #${{ github.event.pull_request.number }}" || echo "Nothing to commit"
+        git push
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -16,6 +16,7 @@ concurrency:
 
 permissions:
   contents: write
+  pull-requests: write
 
 jobs:
   docs:
@@ -41,12 +42,20 @@ jobs:
           # Run doctest with sphinx, to get the extra IGNORE_OUTPUT primitive
           # using plot_gallery=0 to avoid building examples
           sphinx-build -M doctest docs/source/ docs/build/ -D plot_gallery=0 -v $_doctest_files
-      - name: Deploy
+      - name: Deploy PR Docs to gh-pages
         uses: peaceiris/actions-gh-pages@v3
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' || github.event_name == 'pull_request' }}
         with:
-          publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
           publish_dir: _build/
-          force_orphan: true
+          destination_dir: ${{ github.event_name == 'pull_request' && format('pr-preview/pr-{0}', github.event.pull_request.number) || '' }}
+          keep_files: true
           enable_jekyll: false
+          force_orphan: false      
+      - name: Comment on PR with preview url
+        uses: mshick/add-pr-comment@v2
+        if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
+        with:
+          message: |
+            Documentation preview for this PR at ${{ format('https://deepinv.github.io/deepinv/pr-preview/pr-{0}', github.event.pull_request.number) }}
diff --git a/.github/workflows/expose_doc.yml b/.github/workflows/expose_doc.yml
diff --git a/CITATION.cff b/CITATION.cff
@@ -56,7 +56,7 @@ authors:
     given-names: "Romain"
   - family-names: "Weiss"
     given-names: "Pierre"
-version: "0.3.0"
+version: "0.3.2"
 doi: "https://doi.org/10.48550/arXiv.2505.20160"
 date-released: 2023-06-30
 repository-code: "https://github.com/deepinv/deepinv"
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -44,7 +44,13 @@ check the following points:
   After making the desired changes, check the documentation by installing
   ``sphinx`` and building the docs by running one of the commands in the table below in the ``docs`` directory.
   Note that if the build process fails, supplementary additional libraries may need to be manually installed
-  (e.g. ``sphinx-gallery``): please follow instructions in the log.
+  (e.g. ``sphinx-gallery``): please follow instructions in the log. 
+
+.. tip::
+
+  Once the GitHub tests have been approved by a maintainer (only required for first-time contributors), and the `Build Docs` GitHub action
+  has run successfully, you can check the generated docs online at https://deepinv.github.io/deepinv/pr-preview/pr-N/ where `N` is the PR number.
+
 
 .. list-table::
    :widths: 40 50
