Merge pull request #1344 from opendatacube/doc-preview

setup readthedoc preview github ci for doc preview before merge
opendatacube · Nov 3, 2022 · d96a506 · d96a506
2 parents 7dff38d + 29f6984
commit d96a506
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/.github/workflows/doc-qa.yaml b/.github/workflows/doc-qa.yaml
@@ -47,3 +47,10 @@ jobs:
           uses: docker://oskarstark/doctor-rst
           with:
               args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache
+
+  documentation-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "datacube-core"
diff --git a/docs/about/whats_new.rst b/docs/about/whats_new.rst
@@ -17,6 +17,7 @@ v1.8.next
 - Add what's new page link to menu and general doc fixes (:pull:`1335`)
 - Add `search_fields` to required for metadata type schema and update doc (:pull:`1339`)
 - Fix typo and update metadata documentation (:pull:`1340`)
+- Add readthedoc preview github action (:pull:`1344`)
 
 .. _PEP561: https://peps.python.org/pep-0561/