Skip to content

Update MkDocs installation to include additional plugins #2

Update MkDocs installation to include additional plugins

Update MkDocs installation to include additional plugins #2

Workflow file for this run

on:
push:
branches: [ main ]
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
pip install mkdocs mkdocs-material 'mkdocstrings[python]' mkdocs-gen-files mkdocs-literate-nav mkdocs-include-markdown-plugin
- name: Generate metric tables
run: |
if [ -f docs/gen_metric_tables.py ]; then python docs/gen_metric_tables.py; fi
- name: Build MkDocs site
run: mkdocs build --site-dir site
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
publish_dir: ./site
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}