Build documentation for offline usage #178
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: | |
- uses: actions/checkout@v3 | |
with: | |
ref: ${{ matrix.branch }} | |
- name: Install dependencies | |
run: | | |
sudo pip3 install -r requirements.txt | |
sudo pip3 install codespell | |
- name: Sphinx build HTML | |
run: make SPHINXOPTS='--color' 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 |