Skip to content

πŸš€ Deploy static documentation to root #3

πŸš€ Deploy static documentation to root

πŸš€ Deploy static documentation to root #3

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme
pip install -e .
- name: Build documentation
run: |
cd docs
sphinx-build -b html . ../docs-built
cd ..
cp -r docs-built/* .
rm -rf docs-built
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .