Skip to content
Deploy Documentation

docs: Add comprehensive MkDocs documentation #2

Sign in to view logs

docs: Add comprehensive MkDocs documentation

docs: Add comprehensive MkDocs documentation #2

Workflow file for this run

.github/workflows/docs.yml at a788e9e
name: Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 # v4.3.0
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
with:
python-version: '3.x'
- name: Install dependencies
run: |
pip install mkdocs-material mkdocstrings[python]
- name: Build documentation
run: mkdocs build
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
run: mkdocs gh-deploy --force