12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061 |
- 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@v4
- 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@v4
- 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
|