Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
70 changes: 70 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Publish documentation

on:
push:
branches: [main]
paths:
- docs/**
- mkdocs.yml
- requirements-docs.txt
- scripts/**
- benchmark/**
- README.md
- .github/workflows/pages.yml
pull_request:
paths:
- docs/**
- mkdocs.yml
- requirements-docs.txt
- scripts/**
- benchmark/**
- README.md
- .github/workflows/pages.yml
workflow_dispatch:

permissions:
contents: read

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: pip
cache-dependency-path: requirements-docs.txt
- name: Install documentation dependencies
run: pip install -r requirements-docs.txt
- name: Build strict documentation site
run: mkdocs build --strict
- name: Verify golden-manual coverage and links
run: python3 scripts/verify_golden_manual.py
- name: Configure Pages
if: github.event_name != 'pull_request'
uses: actions/configure-pages@v5
- name: Upload Pages artifact
if: github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: site

deploy:
if: github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
pages: write
id-token: write
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
# Build outputs
output/
**/output/
/site/
__pycache__/
*.py[cod]

# Temporary files
*.log
Loading
Loading