Skip to content

Fix the docs example for the snake_case rename #105

Fix the docs example for the snake_case rename

Fix the docs example for the snake_case rename #105

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
paths:
- 'docs/**'
- 'rmcp/**'
- 'README.md'
- 'CONTRIBUTING.md'
- '.github/workflows/docs.yml'
# Allow manual trigger
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
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: docs-${{ github.ref }}
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
# Build documentation
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v7
- name: Install uv
uses: astral-sh/setup-uv@v8.3.2
with:
enable-cache: true
cache-dependency-glob: "uv.lock"
- name: Set up Python
run: uv python install 3.11
- name: Install dependencies
run: |
uv sync --group docs
- name: Build Sphinx documentation
run: |
uv run sphinx-build -b html docs docs/_build/html
- name: Setup Pages
uses: actions/configure-pages@v6
- name: Upload artifact
uses: actions/upload-pages-artifact@v5
with:
path: './docs/_build/html'
# Deploy to GitHub Pages
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