build_offline_docs.yml

name: Build documentation for offline usage
on:
  workflow_dispatch:
  schedule:
    # Every week on Monday at midnight (UTC).
    # This keeps the generated HTML documentation fresh.
    - cron: '0 0 * * 1'

jobs:
  build:
    runs-on: ubuntu-20.04
    strategy:
      matrix:
        branch:
          - master
          - stable
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          ref: ${{ matrix.branch }}

      - name: Install dependencies
        run: |
          sudo pip3 install -r requirements.txt
          sudo pip3 install codespell

      # Build the HTML to upload it.
      - name: Sphinx build
        run: |
          sphinx-build --color -d _build/doctrees . _build/html

      - uses: actions/upload-artifact@v3
        with:
          name: godot-docs-html-${{ matrix.branch }}
          path: _build/html
          # Keep the current build and the previous build (in case a scheduled build failed).
          # This makes it more likely to have at least one successful build available at all times.
          retention-days: 15