Build and deploy documentation to GitHub Pages 📃 #7
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and deploy documentation to GitHub Pages 📃 | |
on: | |
workflow_dispatch: | |
jobs: | |
build: | |
name: Build and deploy documentation to GitHub Pages 📃 | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repository code | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.8" | |
- name: Upgrade pip | |
run: | | |
python -m pip install --upgrade pip | |
- name: Install dependencies | |
run: | | |
pip install -e .[vis,doc] | |
- name: Build docs | |
run: | | |
sphinx-build -b html docs/ ./public | |
cp -r docs/additional_resources/* ./public/ | |
- name: Deploy docs | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./public |