Merge Develop #126
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 Documentation | |
on: | |
push: | |
branches: | |
- main | |
tags: | |
- 'v*' | |
pull_request: | |
branches: | |
- main | |
workflow_dispatch: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: ["3.10"] | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Initialize Virtualenv | |
run: | | |
python -m pip install --upgrade pip virtualenv | |
python -m venv .venv | |
- name: Install dependencies | |
run: | | |
source .venv/bin/activate | |
pip install -r requirements.txt | |
pip install -r docs/requirements.txt | |
- name: Install package into virtualenv | |
run: | | |
source .venv/bin/activate | |
pip install -e . | |
- name: Build docs | |
run: | | |
source .venv/bin/activate | |
cd docs | |
make html | |
- name: Store docs as an artifact | |
uses: actions/upload-artifact@v4 | |
with: | |
name: html-docs | |
path: docs/_build/html | |
- name: Deploy docs | |
uses: peaceiris/actions-gh-pages@v4 | |
if: ${{ github.ref == 'refs/heads/main' }} | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./docs/_build/html |