Skip to content

Remove strict mode for docs building #8

Remove strict mode for docs building

Remove strict mode for docs building #8

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
# Build and deploy docs
deploy:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install UV
uses: astral-sh/setup-uv@v3
with:
version: "latest"
- name: Install dependencies
run: |
uv sync --extra docs
uv pip install .
- name: Build documentation
run: |
uv run mkdocs build
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
publish_branch: gh-pages
force_orphan: true
# Build only job for PRs
build:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install UV
uses: astral-sh/setup-uv@v3
with:
version: "latest"
- name: Install dependencies
run: |
uv sync --extra docs
uv pip install .
- name: Build documentation (test only)
run: |
uv run mkdocs build --strict