Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: 📚 Generate Documentation

on:
pull_request:
branches: ["main"]
push:
branches: [ main ]
paths:
- 'mcpgateway/**'
- 'docs/**'
- 'README.md'
- 'mkdocs.yml'
workflow_dispatch:

jobs:
docs:
runs-on: ubuntu-latest
permissions:
contents: write
pages: write
id-token: write

steps:
- name: 📦 Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y graphviz

- name: 📚 Install Python dependencies
run: |
python -m pip install --upgrade pip
pip install code2flow snakefood3 pylint handsdown mkdocs mkdocs-material pytest

- name: 🧪 Run tests for reports
run: make -f ./Makefile test

- name: 📝 Generate documentation
run: make docs

- name: 🚀 Setup Pages
uses: actions/configure-pages@v4

- name: 📋 Build with MkDocs
run: mkdocs build

- name: 📤 Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './site'

# - name: 🌐 Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v2
Loading