10_24_2024: added miltistart optimization example #122
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 docs | |
on: | |
push: | |
branches: [ main ] | |
tags: | |
- 'v*.*.*' | |
release: | |
types: [ created ] | |
permissions: | |
contents: write | |
jobs: | |
docs-gen: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
fetch-depth: 1 | |
- uses: actions/setup-python@v3 | |
with: | |
python-version: "3.12" | |
- name: Install dependencies | |
run: | | |
sudo apt install pandoc | |
pip install --upgrade pip | |
pip install -e .[docs] | |
- name: Sphinx build | |
run: | | |
sphinx-build docs/source docs/build | |
- name: Deploy docs | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
allow_empty_commit: true | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_branch: gh-pages | |
publish_dir: docs/build/ |