deepset-mcp-server/mkdocs.yml at main · deepset-ai/deepset-mcp-server · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
site_name: deepset MCP Documentation
theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - search.suggest

markdown_extensions:
  - toc:
      toc_depth: 3
  - pymdownx.highlight: # syntax highlighting (Pygments)
      anchor_linenums: true   # optional
      linenums: false         # set true if you want line numbers
  - pymdownx.inlinehilite     # `#!python` etc. for inline code
  - pymdownx.superfences      # needed so fenced/converted blocks render reliably
  - admonition                # (optional, but commonly used)

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx  # or numpy/sphinx
            show_source: false
            show_signature_annotations: true
            show_root_heading: false
            show_root_full_path: true        # Don't show full module paths
            show_root_members_full_path: true # Don't show full paths for members
            show_root_toc_entry: false
            separate_signature: true  # ← Separates signature from docstring
            signature_crossrefs: true
            heading_level: 2

            crossrefs:
              enable_args: true
              enable_return: true

            # Make sure all your classes are documented
            filters: [ "!^_" ]  # Show all non-private members
            members_order: source
            # show_submodules: true

nav:
  - Home: index.md
  - Installation: installation.md
  - Guides:
      - MCP Server: guides/mcp_server.md
      - API SDK: guides/api_sdk.md
  - Concepts:
      - MCP Server: concepts/mcp_server_concepts.md
      - API SDK: concepts/sdk_concepts.md
  - Reference:
      - Server Reference: reference/mcp_reference.md
      - Tool Reference: reference/tool_reference.md
      - API SDK Reference: reference/api_sdk_reference.md