diff options
Diffstat (limited to '.github/workflows/docs.yaml')
| -rw-r--r-- | .github/workflows/docs.yaml | 42 |
1 files changed, 36 insertions, 6 deletions
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index ad10f75f..5254d524 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,13 +32,42 @@ 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: Uplaod Build Artifact + - 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 + + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 # We need to check out the entire repository to find all tags + + - 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: ${{ github.event_name == 'pull_request' }} + BRANCH_NAME: ${{ github.head_ref }} + + - name: Upload Build Artifact uses: actions/upload-artifact@v2 with: name: docs |