[v1.x] ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages ar… · modelcontextprotocol/python-sdk@9773a3f · GitHub
Skip to content

Commit 9773a3f

Browse files
authored
[v1.x] ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages artifact (#2635)
1 parent 77431eb commit 9773a3f

8 files changed

Lines changed: 117 additions & 63 deletions

File tree

‎.github/workflows/deploy-docs.yml‎

Lines changed: 57 additions & 0 deletions

‎.github/workflows/publish-docs-manually.yml‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.github/workflows/publish-pypi.yml‎

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -51,32 +51,3 @@ jobs:
5151

5252
- name: Publish package distributions to PyPI
5353
uses: pypa/gh-action-pypi-publish@release/v1
54-
55-
docs-publish:
56-
runs-on: ubuntu-latest
57-
needs: ["pypi-publish"]
58-
permissions:
59-
contents: write
60-
steps:
61-
- uses: actions/checkout@v4
62-
- name: Configure Git Credentials
63-
run: |
64-
git config user.name github-actions[bot]
65-
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
66-
67-
- name: Install uv
68-
uses: astral-sh/setup-uv@v3
69-
with:
70-
enable-cache: true
71-
version: 0.9.5
72-
73-
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
74-
- uses: actions/cache@v4
75-
with:
76-
key: mkdocs-material-${{ env.cache_id }}
77-
path: .cache
78-
restore-keys: |
79-
mkdocs-material-
80-
81-
- run: uv sync --frozen --group docs
82-
- run: uv run --frozen --no-sync mkdocs gh-deploy --force

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ venv.bak/
143143

144144
# mkdocs documentation
145145
/site
146+
/.worktrees/
146147

147148
# mypy
148149
.mypy_cache/

‎docs/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# MCP Python SDK
22

3+
!!! tip "Looking for the upcoming v2?"
4+
See the [v2 development documentation](https://py.sdk.modelcontextprotocol.io/v2/).
5+
36
The **Model Context Protocol (MCP)** allows applications to provide context for LLMs in a standardized way, separating the concerns of providing context from the actual LLM interaction.
47

58
This Python SDK implements the full MCP specification, making it easy to:

‎mkdocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ strict: true
55
repo_name: modelcontextprotocol/python-sdk
66
repo_url: https://github.com/modelcontextprotocol/python-sdk
77
edit_uri: edit/v1.x/docs/
8-
site_url: https://modelcontextprotocol.github.io/python-sdk
8+
site_url: https://py.sdk.modelcontextprotocol.io/
99

1010
# TODO(Marcelo): Add Anthropic copyright?
1111
# copyright: © Model Context Protocol 2025 to present

‎pyproject.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ bump = true
8585

8686
[project.urls]
8787
Homepage = "https://modelcontextprotocol.io"
88+
Documentation = "https://py.sdk.modelcontextprotocol.io/"
8889
Repository = "https://github.com/modelcontextprotocol/python-sdk"
8990
Issues = "https://github.com/modelcontextprotocol/python-sdk/issues"
9091

‎scripts/build-docs.sh‎

Lines changed: 54 additions & 0 deletions

0 commit comments

Comments
 (0)