linkchecker/.github/workflows/publish-pages.yml
Chris Mayo c7989eb058 Turn all warnings into errors when building website
Drop code target, sphinx-autogen is not using conf.py, and since Sphinx
4.0 autosummary is generating stub pages by default anyway.

Mock ctypes and linkcheck.__main__: colorama.py imports MS Windows
libraries, autosummary executes __main__.py.
2022-11-02 19:24:35 +00:00

46 lines
1.2 KiB
YAML

name: Publish LinkChecker Documentation on GitHub Pages
on:
push:
branches: ["master"]
release:
types: [released]
jobs:
run:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
# Needed for hatch-vcs to extract LinkChecker version from tag
# https://github.com/actions/checkout/issues/249
with:
fetch-depth: 0
- name: Install Ubuntu packages
run: sudo apt install graphviz
# Ensure sphinx-autogen is installed in PATH
- name: Setup Python
uses: actions/setup-python@v4
- name: Install Python packages
run: >
pip install dnspython beautifulsoup4 requests \
hatchling hatch-vcs sphinx sphinx_epytext \
sphinx_rtd_theme sphinx-sitemap
- name: Build
run: |
python3 -m hatchling build -t sdist --hooks-only
make -C doc html
- name: Publish
uses: peaceiris/actions-gh-pages@de7ea6f8efb354206b205ef54722213d99067935
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./doc/html
commit_message: ${{ github.event.head_commit.message }}