Skip to content

Merge pull request #68 from OVVO-Financial/claude/python-docs-pypi-li… #2

Merge pull request #68 from OVVO-Financial/claude/python-docs-pypi-li…

Merge pull request #68 from OVVO-Financial/claude/python-docs-pypi-li… #2

Workflow file for this run

name: Docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
workflow_dispatch:
# Allow only one concurrent deployment, and let in-progress runs finish.
concurrency:
group: pages
cancel-in-progress: false
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
name: Build site
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.12"
- name: Install MkDocs
run: |
python -m pip install -U pip
python -m pip install \
"mkdocs-material>=9.5" \
"pymdown-extensions>=10"
- name: Build (strict)
run: mkdocs build --strict
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4