Skip to content

Documentation cleanup and workflow enhancement (#19) #31

Documentation cleanup and workflow enhancement (#19)

Documentation cleanup and workflow enhancement (#19) #31

Workflow file for this run

name: Docs
on:
push:
branches:
- master
release:
types:
- created
workflow_dispatch:
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: "3.11"
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install dependencies
run: pip install .[docs]
- name: Deploy dev documentation
if: github.ref == 'refs/heads/master'
run: mike deploy --push dev
- name: Get Pyventus Docs Version
if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
run: |
pyventus_docs_version=$(python -c "import pyventus; print('.'.join(map(str, pyventus.__version__.split('.')[:2])))")
echo "PYVENTUS_DOCS_VERSION=$pyventus_docs_version" >> $GITHUB_ENV
- name: Deploy release documentation
if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
run: mike deploy --push --update-aliases $PYVENTUS_DOCS_VERSION latest