Skip to content

Docs

Docs #161

Workflow file for this run

name: Docs
on:
push:
schedule:
- cron: 0 0 * * *
jobs:
docs:
name: Docs
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup uv
uses: astral-sh/setup-uv@v4
- name: Install Dependencies
run: uv sync --all-extras
- name: Build Documentation
run: uv run mkdocs build
- name: Upload Artifacts
uses: actions/upload-artifact@v4
with:
name: docs
path: site/
- if: github.ref == 'refs/heads/main'
name: Deploy to GitHub Pages
run: uv run mkdocs gh-deploy --force --no-history
rtd:
name: Read the Docs
if: github.event_name == 'schedule'
runs-on: ubuntu-latest
steps:
- name: Trigger a new build
run: |-
curl \
-X POST \
-H "Authorization: Token ${{ secrets.RTD_TOKEN }}" https://readthedocs.org/api/v3/projects/route-rules/versions/latest/builds/