aboutsummaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2022-05-29 23:25:33 +0400
committerGravatar Hassan Abouelela <[email protected]>2022-05-29 23:25:33 +0400
commit41f6b02a7d6bd83a6636d83c0bcbaea6988cd6bb (patch)
tree8ac7e39584bc9a743067e1b3ce21556430267a21 /.github
parentOnly Build Current Branch When Option Enabled (diff)
Update Docs CI For Multiversion
Signed-off-by: Hassan Abouelela <[email protected]>
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/docs.yaml39
1 files changed, 34 insertions, 5 deletions
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 79a96ea5..82344abc 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -13,8 +13,9 @@ concurrency:
jobs:
- build-deploy:
- name: Build & Deploy Docs
+ latest-build:
+ # We only need to verify that the docs build with no warnings here
+ name: Build Latest Docs Version
runs-on: ubuntu-latest
steps:
@@ -31,15 +32,43 @@ jobs:
# https://github.com/bitprophet/releases/pull/82
- run: pip install six
- - name: Generate AutoDoc References
- run: sphinx-apidoc -o docs/output botcore -feM
-
- name: Generate HTML Site
run: sphinx-build -nW -j auto -b html docs docs/build
- name: Upload Build Artifact
uses: actions/upload-artifact@v2
with:
+ name: docs-latest
+ path: docs/build/*
+
+ build-deploy:
+ name: Build & Deploy Docs
+ runs-on: ubuntu-latest
+ needs:
+ - latest-build
+
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: Install Python Dependencies
+ uses: HassanAbouelela/actions/setup-python@setup-python_v1.1.0
+ with:
+ dev: true
+ python_version: 3.9
+ install_args: "--extras async-rediscache"
+
+ # Undeclared dependency for `releases`... whoops
+ # https://github.com/bitprophet/releases/pull/82
+ - run: pip install six
+
+ - name: Build All Doc Versions
+ run: sphinx-multiversion docs docs/build -n -j auto
+ env:
+ BUILD_DOCS_FOR_HEAD: True
+
+ - name: Upload Build Artifact
+ uses: actions/upload-artifact@v2
+ with:
name: docs
path: docs/build/*