add sphinx CI job

bytedance · Dec 7, 2024 · 3c58ffe · 3c58ffe
1 parent 593f161
commit 3c58ffe
Show file tree

Hide file tree

Showing 9 changed files with 34 additions and 21 deletions.
diff --git a/.github/workflows/codecov.yml b/.github/workflows/codecov.yml
@@ -5,9 +5,7 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
+      - 'sphinx/**'
       - 'Cargo.lock'
       - 'Cargo.toml'
     branches:
@@ -17,9 +15,7 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
+      - 'sphinx/**'
       - 'Cargo.lock'
       - 'Cargo.toml'
     branches:

diff --git a/.github/workflows/cross.yml b/.github/workflows/cross.yml
@@ -5,10 +5,8 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
+      - 'sphinx/**'
       - 'scripts/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
     branches:
       - 'master'
       - 'lts/**'

diff --git a/.github/workflows/linux.yml b/.github/workflows/linux.yml
@@ -5,10 +5,8 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
+      - 'sphinx/**'
       - 'scripts/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
     branches:
       - 'master'
       - 'lts/**'

diff --git a/.github/workflows/macos.yml b/.github/workflows/macos.yml
@@ -5,10 +5,8 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
+      - 'sphinx/**'
       - 'scripts/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
     branches:
       - 'master'
       - 'lts/**'

diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,23 @@
+name: Sphinx-Doc
+
+on:
+  push:
+    paths:
+      - 'sphinx/**'
+  pull_request:
+    paths:
+      - 'sphinx/**'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        component:
+          - g3proxy
+          - g3tiles
+  steps:
+    - uses: actions/checkout@v4
+    - uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "sphinx/${{ matrix.component }}"
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -5,10 +5,8 @@ on:
     paths-ignore:
       - 'ansible/**'
       - 'doc/**'
-      - 'demo/**'
+      - 'sphinx/**'
       - 'scripts/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
     branches:
       - 'master'
       - 'lts/**'

diff --git a/.github/workflows/windows.yml b/.github/workflows/windows.yml
@@ -6,9 +6,7 @@ on:
       - 'ansible/**'
       - 'doc/**'
       - 'demo/**'
-      - 'scripts/**'
-      - 'g3proxy/doc/**'
-      - 'g3tiles/doc/**'
+      - 'sphinx/**'
     branches:
       - 'master'
       - 'lts/**'

diff --git a/sphinx/g3proxy/requirements.txt b/sphinx/g3proxy/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx-rtd-theme
diff --git a/sphinx/g3tiles/requirements.txt b/sphinx/g3tiles/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+sphinx-rtd-theme