Skip to content

chore(mkdocs): exclude in-progress docs from build #147

chore(mkdocs): exclude in-progress docs from build

chore(mkdocs): exclude in-progress docs from build #147

Workflow file for this run

# Deploy Documentation to GitHub Pages
# Uses MkDocs with Material theme for beautiful documentation
# Includes interactive mind maps
name: Deploy Documentation
on:
push:
branches: [main]
paths:
- 'docs/**'
- 'ontology/**'
- 'meta/**'
- 'tools/mindmaps/generate_mindmaps.py'
- 'mkdocs.yml'
workflow_dispatch: # Allow manual trigger
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch full Git history (required for git-revision-date-localized plugin)
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
pip install -U pip
pip install -e .
pip install -r requirements.txt
- name: Generate Mind Maps (Markdown + HTML)
run: |
python tools/mindmaps/generate_mindmaps.py
python tools/mindmaps/generate_mindmaps.py --html
- name: Build MkDocs site
run: |
mkdocs build
- name: Copy mind map HTML files
run: |
cp -r docs/pages/mindmaps site/pages/mindmaps
cp -r docs/pages/assets site/pages/assets 2>/dev/null || true
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'site'
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4