tju-python/mkdocs.yml at main · tjuse/tju-python · 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
58
59
60
61
62
63
64
65
66
67
68
69
70
site_name: tju
site_description: Python client for TJU SSO and EAMS
site_url: https://python.tjuse.com/
repo_url: https://github.com/tjuse/tju-python
repo_name: tjuse/tju-python
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - content.code.copy

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Examples: examples.md
  - API Reference:
      - Client: api/client.md
      - Session: api/session.md
      - Models: api/models.md
      - Parsers: api/parsers.md
      - Exceptions: api/exceptions.md
  - TUI: tui.md
  - MCP Server: mcp.md
  - Contributing: contributing.md
  - Changelog: changelog.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.snippets:
      base_path: .
  - admonition
  - toc:
      permalink: true