ci: use ReadtheDocs PR preview instead of building docs in github action

haote.yang · haote.yang · commit 1de942fece92 · 2021-05-18T22:49:37.000+08:00
References: https://docs.readthedocs.io/en/stable/pull-requests.html https://docs.readthedocs.io/en/stable/config-file/v2.html#sphinx-fail-on-warning
diff --git a/.github/workflows/build_docs.yaml b/.github/workflows/build_docs.yaml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+---
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  fail_on_warning: true
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: requirements.txt
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -35,7 +35,7 @@ It provides:
    :caption: Quick Start
 
    quick_start/getting_started_with_tensorbay
-   quick_start/examples
+   quick_start/examples_
 
 .. toctree::
    :maxdepth: 1
