DeepWerewolf/mkdocs.yml at main · af-74413592/DeepWerewolf · 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
site_name: Agent Lightning
site_url: https://microsoft.github.io/agent-lightning/
repo_url: https://github.com/microsoft/agent-lightning
repo_name: agent-lightning

theme:
  name: material
  logo: assets/logo-light.png
  # Don't set favicon here - we'll handle it dynamically
  palette:
    - scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-authors
  - macros
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
  - mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: latest

extra:
  version:
    provider: mike
    default: latest
  source_commit: !ENV [SOURCE_COMMIT, 'main']

extra_javascript:
  - https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.js
  - js/favicon-theme.js

nav:
  - Home: index.md
  - Quickstart:
    - Installation: quickstart/installation.md
    - Getting Started: quickstart/getting-started.md
  - How-To Guides:
    - Train SQL Agent: how-to/train-sql-agent.md
  - Deep Dive:
    - Server-Client Architecture: deep-dive/server-client-architecture.md
  - API Reference:
    - Core: reference/core.md
    - RL: reference/rl.md