mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
942ed1f1c8
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
61 lines
2.3 KiB
YAML
61 lines
2.3 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-22.04
|
|
strategy:
|
|
matrix:
|
|
branch:
|
|
- master
|
|
- 3.6
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
ref: ${{ matrix.branch }}
|
|
|
|
- name: Install dependencies
|
|
run: |
|
|
sudo pip3 install -r requirements.txt
|
|
sudo pip3 install codespell
|
|
sudo apt update
|
|
sudo apt install parallel libwebp7
|
|
|
|
- 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
|
|
|
|
- name: Sphinx - Build ePub
|
|
run: |
|
|
# Convert WebP images to PNG and replace references, so that ePub readers can display those images.
|
|
# The ePub 3.0 specification has WebP support, but it's not widely supported by apps and e-readers yet.
|
|
shopt -s globstar nullglob
|
|
parallel --will-cite convert {} {.}.png ::: {about,community,contributing,getting_started,img,tutorials}/**/*.webp
|
|
parallel --will-cite sed -i "s/\\.webp$/\\.png/g" ::: {about,community,contributing,getting_started,tutorials}/**/*.rst
|
|
|
|
# Remove banners at the top of each page when building `latest`.
|
|
sed -i 's/"godot_is_latest": True/"godot_is_latest": False/' conf.py
|
|
sed -i 's/"godot_show_article_status": True/"godot_show_article_status": False/' conf.py
|
|
|
|
make SPHINXOPTS='--color' epub
|
|
|
|
- uses: actions/upload-artifact@v3
|
|
with:
|
|
name: godot-docs-epub-${{ matrix.branch }}
|
|
path: _build/epub/GodotEngine.epub
|
|
# 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
|