Try more detailed fawltydeps options #14
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
name: Build Documentation | |
on: | |
pull_request: | |
push: | |
branches: | |
- main | |
jobs: | |
build-doc: | |
runs-on: ubuntu-latest | |
env: | |
PYTHON-VERSION: "3.11" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ env.PYTHON-VERSION }} | |
- name: Upgrade pip & install nox | |
run: | | |
# install pip=>20.1 to use "pip cache dir" | |
python3 -m pip install --upgrade pip | |
pip install nox | |
- name: Set Variables | |
id: set_variables | |
shell: bash | |
run: | | |
echo "PY=$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')" >> $GITHUB_OUTPUT | |
echo "PIP_CACHE=$(pip cache dir)" >> $GITHUB_OUTPUT | |
- name: Cache dependencies | |
uses: actions/cache@v4 | |
with: | |
path: ${{ steps.set_variables.outputs.PIP_CACHE }} | |
key: ${{ runner.os }}-pip-${{ steps.set_variables.outputs.PY }} | |
- name: Install dependencies | |
run: | | |
pip install nox | |
- name: Build docs & linkcheck | |
run: | | |
# Build html and link check | |
nox -s docs | |
- name: Print doc link failures in the output.txt file | |
if: success() || failure() | |
run: | | |
cat docs/_build/linkcheck/output.txt | while read line | |
do | |
echo -e "$line \n" | |
done |