From 132d774953886157f02cd6301b4ce23ae2b63726 Mon Sep 17 00:00:00 2001 From: Will Barrett Date: Mon, 20 Apr 2020 15:48:50 -0700 Subject: [PATCH] Add documentation build to Github Actions (#9569) * Add documentation build to Github Actions * Update requirements for documentation builds * Minor optimization - only install requirements for documentation in documentation job --- .github/workflows/superset-python.yml | 23 +++++++++++++++++++++++ docs/requirements.txt | 4 ++-- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/.github/workflows/superset-python.yml b/.github/workflows/superset-python.yml index a54f5e96457af..8d8a6a8c5f832 100644 --- a/.github/workflows/superset-python.yml +++ b/.github/workflows/superset-python.yml @@ -29,6 +29,29 @@ jobs: # `-j 0` run Pylint in parallel run: pylint -j 0 superset + docs: + runs-on: ubuntu-18.04 + strategy: + matrix: + python-version: [3.6] + steps: + - name: Checkout code + uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v1 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + uses: apache-superset/cached-dependencies@adc6f73 + with: + run: | + pip-install + pip install -r docs/requirements.txt + - name: Copy Images + run: cp -r superset-frontend/images/ docs/_static/images/ + - name: Build documentation + run: sphinx-build -b html docs _build/html -W + test-postgres: runs-on: ubuntu-18.04 strategy: diff --git a/docs/requirements.txt b/docs/requirements.txt index 113860b3dc976..f1b96ba607adf 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -14,6 +14,6 @@ # See the License for the specific language governing permissions and # limitations under the License. # -sphinx==2.1.2 -sphinx_autodoc_typehints==1.6.0 +sphinx==3.0.1 +sphinx_autodoc_typehints==1.10.3 sphinx-rtd-theme==0.4.3