[kyuubi] branch master updated: [KYUUBI #4269] Add a GA Job For Documentation Verification

[ch...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

chengpan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git


The following commit(s) were added to refs/heads/master by this push:
     new 1c7a66ff8 [KYUUBI #4269] Add a GA Job For Documentation Verification
1c7a66ff8 is described below

commit 1c7a66ff84a3051bd799c552049f6b50abc73d28
Author: Kent Yao <ya...@apache.org>
AuthorDate: Thu Feb 9 12:53:47 2023 +0000

    [KYUUBI #4269] Add a GA Job For Documentation Verification
    
    ### _Why are the changes needed?_
    
    Add a GA Job For Documentation Verification
    
    ### _How was this patch tested?_
    - [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible
    
    - [ ] Add screenshots for manual tests if appropriate
    
    - [ ] [Run test](https://kyuubi.readthedocs.io/en/master/develop_tools/testing.html#running-tests) locally before make a pull request
    
    Closes #4269 from yaooqinn/docga.
    
    Closes #4269
    
    c9b39de6 [Cheng Pan] Update .github/workflows/docs.yml
    db2d37f8 [Kent Yao] Update .github/workflows/docs.yml
    c5bc8518 [Kent Yao] trigger ga
    6340129b [Kent Yao] trigger ga
    fafbf847 [Kent Yao] trigger ga
    52f23240 [Kent Yao] trigger ga
    1e0000a7 [Kent Yao] Add a GA Job For Documentaion Verification
    
    Lead-authored-by: Kent Yao <ya...@apache.org>
    Co-authored-by: Cheng Pan <pa...@gmail.com>
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 .github/workflows/docs.yml | 48 ++++++++++++++++++++++++++++++++++++++++++++++
 docs/requirements.txt      |  4 ++--
 2 files changed, 50 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..55cb6b8b1
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,48 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name: Docs
+
+on:
+  pull_request:
+    branches:
+      - master
+
+concurrency:
+  group: docs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  sphinx:
+    name: sphinx-build
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+          cache: 'pip'
+          cache-dependency-path: docs/requirements.txt
+      - run: pip install -r docs/requirements.txt
+      - name: make html
+        run: make -d --directory docs html
+      - name: upload html
+        uses: actions/upload-artifact@v3
+        with:
+          path: |
+            docs/_build/html/
+            !docs/_build/html/_sources/
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 8a5ee7e12..00a2eb136 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -22,6 +22,6 @@ markdown==3.3.7
 recommonmark==0.7.1
 sphinx==4.5.0
 sphinx-book-theme==0.3.3
-sphinx-markdown-tables==0.0.15
-sphinx-notfound-page==0.8
+sphinx-markdown-tables==0.0.17
+sphinx-notfound-page==0.8.3
 sphinx-togglebutton===0.3.2