Merge pull request #205 from dwreeves/add-macports-note #32
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 docs | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
# Cancel if a newer run is started | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
cancel-in-progress: true | |
jobs: | |
rich_codex: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out the repo | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
- name: Install requirements for docs | |
run: | | |
pip install -U uv | |
uv pip install --system --editable ".[docs]" | |
- name: Generate terminal images with rich-codex | |
uses: ewels/rich-codex@v1 | |
with: | |
commit_changes: "true" | |
clean_img_paths: docs/images/*.svg | |
skip_git_checks: "true" | |
- name: Build and deploy docs | |
run: mkdocs gh-deploy --force |