Files
godot-docs/.github/workflows/build_offline_docs.yml
T
Hugo Locurcio 7b35584569 GitHub Actions: Don't build with warnings-as-errors for offline doc
The class reference may have invalid parts which otherwise prevent
building the offline documentation.
2021-10-20 16:44:46 +02:00

40 lines
1.1 KiB
YAML

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@v2
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@v2
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