Skip to content

docs: add MCP server documentation for v1.3.0 #20

docs: add MCP server documentation for v1.3.0

docs: add MCP server documentation for v1.3.0 #20

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'src/**'
- 'README.md'
- '.github/workflows/docs.yml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'src/**'
- 'README.md'
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install -e ".[docs]"
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build with Sphinx
run: |
cd docs
make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/_build/html
# Deployment job
deploy:
if: github.ref == 'refs/heads/main'
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