feat: add external coms #240
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 Push github pages | |
on: | |
pull_request: | |
push: | |
branches: | |
- main | |
jobs: | |
build-book: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
- name: Upgrade pip | |
run: | | |
# install pip=>20.1 to use "pip cache dir" | |
python3 -m pip install --upgrade pip | |
- name: Get pip cache dir | |
id: pip-cache | |
run: echo "::set-output name=dir::$(pip cache dir)" | |
- name: Cache dependencies | |
uses: actions/cache@v4 | |
with: | |
path: ${{ steps.pip-cache.outputs.dir }} | |
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
restore-keys: | | |
${{ runner.os }}-pip- | |
- name: Install dependencies | |
run: python3 -m pip install nox | |
- run: nox -s docs | |
- name: Push to gh-pages branch for publication from main | |
if: github.ref == 'refs/heads/main' | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./_build/html | |
# Test for bad links and ensure alt tags for usability | |
- name: Check HTML using htmlproofer | |
uses: chabad360/htmlproofer@v2 | |
with: | |
directory: '_build/html' | |
arguments: | | |
--ignore-files "/.+\/_static\/.+/,/genindex.html/,/.+\/reference\/.+/" | |
--ignore-status-codes "200, 302, 404, 403, 429, 503, 999" |