Files
godot-docs/.github/workflows/build_offline_docs.yml
Hugo Locurcio a3b5a1e349 Use a separate GitHub Actions workflow to build offline documentation (#4733)
This is required to get a permalink using https://nightly.link
as we need the workflow containing the offline docs ZIP artifact
to always be the latest one. Creating a second workflow is a good
way to solve this.

This also makes it easier to distinguish between linting checks
and offline documentation builds in the repository's Actions tab.
2021-03-28 23:46:56 +02:00

32 lines
920 B
YAML

name: Build documentation for offline usage
on:
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
steps:
- name: Checkout
uses: actions/checkout@v2
- 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 -W . _build/html
- uses: actions/upload-artifact@v2
with:
name: godot-docs-html
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