Skip to content

update readme to favor new mkdocs and publish scripts to supply the e… #139

update readme to favor new mkdocs and publish scripts to supply the e…

update readme to favor new mkdocs and publish scripts to supply the e… #139

Workflow file for this run

name: Docs2Pages
on: [ push, pull_request, workflow_dispatch ]
permissions:
contents: write
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Install Python 3.13
run: uv python install 3.13
- name: Install dependencies
run: uv sync --all-extras
- name: Build MkDocs site
run: |
uv run mkdocs build --strict
- name: Deploy documentation
uses: peaceiris/actions-gh-pages@v4
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html
force_orphan: true