Skip to content

test: add comprehensive tests and improve CI badges - Add tests for C… #10

test: add comprehensive tests and improve CI badges - Add tests for C…

test: add comprehensive tests and improve CI badges - Add tests for C… #10

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: 📥 Checkout main branch
uses: actions/checkout@v4
with:
ref: main
- name: 🐍 Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: 📦 Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
pip install -e .
- name: 📚 Build documentation with Sphinx
run: |
cd docs
sphinx-build -b html . _build/html
cd ..
- name: 🚀 Deploy to gh-pages branch
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
publish_branch: gh-pages
force_orphan: true
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: 'Deploy Sphinx docs from main branch'