Skip to content

Complete documentation system with GitHub Actions fix #3

Complete documentation system with GitHub Actions fix

Complete documentation system with GitHub Actions fix #3

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.9'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
# Try to install package, but continue if it fails (docs-only build)
pip install -e . || echo "Package installation failed, continuing with docs-only build"
- name: Build documentation
run: |
echo "Building documentation..."
mkdocs --version
mkdocs build --clean --strict
echo "Documentation build completed successfully"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
if: github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4