Documentation #4217
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
| --- | |
| # yamllint disable rule:line-length | |
| name: Documentation | |
| on: # yamllint disable-line rule:truthy | |
| push: | |
| branches: ["main", "release-*"] | |
| pull_request: | |
| branches: ["main", "release-*"] | |
| # This workflow must be able to be triggered manually so that it can be | |
| # started from another workflow | |
| workflow_dispatch: | |
| jobs: | |
| build-docs: | |
| name: Build docs | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Install prereqs | |
| run: | | |
| echo 'APT::Acquire::Retries "5";' | sudo tee /etc/apt/apt.conf.d/80-retries | |
| sudo apt-get update | |
| sudo DEBIAN_FRONTEND=noninteractive apt-get install -y python3-pip python3-venv | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| ./setup-env.sh | |
| . ../.venv/bin/activate | |
| make html |