Enable previewing generated doc in PR

editorconfig · Jul 16, 2024 · 09f4870 · 09f4870
1 parent 0ea60e1
commit 09f4870
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -0,0 +1,20 @@
+# Preview the generated doc in pull requests.
+
+name: Preview Generated Docs
+on:
+  pull_request_target:
+    types:
+      - opened
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    name: Build Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "readthedocs-preview"