Skip to content

Publish Docs

Publish Docs #82

Workflow file for this run

name: Publish Docs
on:
workflow_dispatch:
release:
types: [published]
push:
tags:
- '[0-9]+.[0-9]+.[0-9]+'
jobs:
publish-doc:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-22.04]
python-version: ["3.10"]
steps:
- name: Checkout Github Repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Cache Python Packages
id: pip-cache
uses: actions/cache@v3
with:
path: /opt/hostedtoolcache/Python
key: ${{ matrix.os }}-python${{ matrix.python-version }}-pip-${{ hashFiles('requirements.txt') }}-${{ hashFiles('requirements-dev.txt') }}
- name: Install Python Packages
if: steps.pip-cache.outputs.cache-hit != 'true'
run: |
python -m pip install --upgrade 'pip<25.1'
pip install -r requirements-dev.txt
pip install -r requirements.txt
- name: Run build-sphinx
run: |
make doc
- name: Deploy gh-pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./html_doc