Skip to content
Documentation

test: improve session module testing and documentation (v3.5.5) #243

Sign in to view logs

test: improve session module testing and documentation (v3.5.5)

test: improve session module testing and documentation (v3.5.5) #243

Workflow file for this run

.github/workflows/docs.yml at 5d07e91
name: Documentation
on:
push:
branches: [ main, develop ]
paths:
- 'docs/**'
- 'src/**'
- '.github/workflows/docs.yml'
- 'mkdocs.yml'
- 'pyproject.toml'
pull_request:
branches: [ main ]
paths:
- 'docs/**'
- 'src/**'
- '.github/workflows/docs.yml'
- 'mkdocs.yml'
- 'pyproject.toml'
# Add permissions for GitHub Pages deployment
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-jupyter pymdown-extensions
pip install -e .
- name: Build documentation
run: |
mkdocs build --verbose
- name: Check for broken links
run: |
pip install linkchecker
linkchecker site/
continue-on-error: true # Don't fail build on broken external links
- name: Upload documentation artifacts
uses: actions/upload-artifact@v4
with:
name: documentation
path: site/
deploy-docs:
runs-on: ubuntu-latest
needs: build-docs
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Configure environment for GitHub Pages deployment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Download documentation artifacts
uses: actions/download-artifact@v4
with:
name: documentation
path: site/
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: site/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4