Build docs and check links #4
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
# This workflow tests building the package docs and verifying links are live. | |
name: Build docs and check links | |
on: | |
schedule: | |
- cron: "10 4 * * 1" # every monday at 04:10 UTC | |
workflow_dispatch: | |
jobs: | |
test_docs_linkcheck: | |
if: ${{ github.repository == 'gboeing/osmnx' }} | |
name: Build docs and check links | |
runs-on: ubuntu-latest | |
timeout-minutes: 5 | |
defaults: | |
run: | |
shell: bash -elo pipefail {0} | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.x" | |
- name: Install requirements | |
run: | | |
python -m pip install --user furo "sphinx==7.*" sphinx-autodoc-typehints | |
python -m pip check | |
- name: Build docs and check links | |
run: python -m sphinx -E -W --keep-going -b linkcheck ./docs/source ./docs/build/linkcheck |