python-sdk/mkdocs.yml at main · evalstate/python-sdk · GitHub

History

134 lines (126 loc) · 3.61 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

site_name: MCP Server

site_description: MCP Server

strict: true

repo_name: modelcontextprotocol/python-sdk

repo_url: https://github.com/modelcontextprotocol/python-sdk

edit_uri: edit/main/docs/

site_url: https://modelcontextprotocol.github.io/python-sdk

# TODO(Marcelo): Add Anthropic copyright?

# copyright: © Model Context Protocol 2025 to present

nav:

- Introduction: index.md

- Installation: installation.md

- Migration Guide: migration.md

- Documentation:

- Concepts: concepts.md

- Low-Level Server: low-level-server.md

- Authorization: authorization.md

- Testing: testing.md

- Experimental:

- Overview: experimental/index.md

- Tasks:

- Introduction: experimental/tasks.md

- Server Implementation: experimental/tasks-server.md

- Client Usage: experimental/tasks-client.md

- API Reference: api.md

theme:

palette:

- media: "(prefers-color-scheme)"

scheme: default

primary: black

accent: black

toggle:

icon: material/lightbulb

- media: "(prefers-color-scheme: light)"

scheme: default

primary: black

accent: black

toggle:

icon: material/lightbulb-outline

- media: "(prefers-color-scheme: dark)"

scheme: slate

primary: white

accent: white

toggle:

icon: material/lightbulb-auto-outline

features:

- search.suggest

- search.highlight

- content.tabs.link

- content.code.annotate

- content.code.copy

- content.code.select

- navigation.path

- navigation.indexes

- navigation.sections

- navigation.tracking

- toc.follow

# logo: "img/logo-white.svg"

# TODO(Marcelo): Add a favicon.

# favicon: "favicon.ico"

# https://www.mkdocs.org/user-guide/configuration/#validation

validation:

omitted_files: warn

absolute_links: warn

unrecognized_links: warn

anchors: warn

markdown_extensions:

- tables

- admonition

- attr_list

- md_in_html

- pymdownx.details

- pymdownx.caret

- pymdownx.critic

- pymdownx.mark

- pymdownx.superfences

- pymdownx.snippets

- pymdownx.tilde

- pymdownx.inlinehilite

- pymdownx.highlight:

pygments_lang_class: true

- pymdownx.extra:

pymdownx.superfences:

custom_fences:

- name: mermaid

format: !!python/name:pymdownx.superfences.fence_code_format

- pymdownx.emoji:

emoji_index: !!python/name:material.extensions.emoji.twemoji

emoji_generator: !!python/name:material.extensions.emoji.to_svg

options:

custom_icons:

- docs/.overrides/.icons

- pymdownx.tabbed:

alternate_style: true

- pymdownx.tasklist:

custom_checkbox: true

- sane_lists # this means you can start a list from any number

watch:

- src/mcp

plugins:

- search

- social:

enabled: !ENV [ENABLE_SOCIAL_CARDS, false]

- glightbox

- mkdocstrings:

handlers:

python:

paths: [src/mcp]

options:

relative_crossrefs: true

members_order: source

separate_signature: true

show_signature_annotations: true

signature_crossrefs: true

group_by_category: false

# 3 because docs are in pages with an H2 just above them

heading_level: 3

inventories:

- url: https://docs.python.org/3/objects.inv

- url: https://docs.pydantic.dev/latest/objects.inv

- url: https://typing-extensions.readthedocs.io/en/latest/objects.inv

python-sdk/mkdocs.yml at main · evalstate/python-sdk · GitHub

Expand file tree

Breadcrumbs

mkdocs.yml

Latest commit

History

Breadcrumbs

mkdocs.yml

File metadata and controls