Skip to content
This repository has been archived by the owner on Apr 21, 2024. It is now read-only.
Build and deploy documentation

Bump version 0.2.0 -> 0.3.0 #41

Sign in to view logs

Bump version 0.2.0 -> 0.3.0

Bump version 0.2.0 -> 0.3.0 #41

Workflow file for this run

.github/workflows/documentation.yaml at 39ba6d3
name: Build and deploy documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
name: Build and deploy documentation
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install Pandoc
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- name: Install dependencies
run: |
pip install ".[docs]"
python -m ipykernel install --user --name python3
- name: Sphinx build
run: |
sphinx-build docs/source docs/build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/
force_orphan: true