LeanInteract/mkdocs.yml at main · augustepoiroux/LeanInteract · 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
91
92
93
94
95
96
97
98
99
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
site_name: LeanInteract
site_description: Python package for seamless interaction with Lean 4 through the Lean REPL
site_author: Auguste Poiroux
site_url: https://augustepoiroux.github.io/LeanInteract/

repo_name: augustepoiroux/LeanInteract
repo_url: https://github.com/augustepoiroux/LeanInteract
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2025 Auguste Poiroux

theme:
  name: material
  custom_dir: docs/theme
  palette:
    # Light mode - respect browser preference and use as default
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode - respect browser preference
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - header.autohide
    - toc.follow
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  language: en

# Extra customization
extra:
  version:
    provider: mike
    default: stable
    alias: true
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/augustepoiroux/LeanInteract
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/lean-interact/

plugins:
  - search
  - mike:
      alias_type: symlink
      redirect_template: null
      canonical_version: null
      version_selector: true
      css_dir: css
      javascript_dir: js
  - markdown-exec
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            inherited_members: true
            members_order: source
            filters: ["!^_"]
            docstring_style: google
            merge_init_into_class: true
            show_if_no_docstring: true
            show_source: true
            annotations_path: brief
            separate_signature: true
            show_signature_annotations: true
            show_overloads: false
            unwrap_annotated: true
            signature_crossrefs: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - LeanInteract: index.md
  - User Guide:
      - Installation: user-guide/installation.md
      - Getting Started: user-guide/getting-started.md
      - Basic Usage: user-guide/basic-usage.md
      - Tactic Mode: user-guide/tactic-mode.md
      - Performance & Parallelization: user-guide/performance.md
      - Data Extraction: user-guide/data-extraction.md
      - Setting Lean Options: user-guide/set-options.md
      - Examples: user-guide/examples.md
      - Custom Lean Configuration: user-guide/custom-lean-configuration.md
      - Troubleshooting: user-guide/troubleshooting.md
  - API Reference:
      - REPL Configuration: api/config.md
      - Lean Server: api/server.md
      - Server Pool: api/pool.md
      - Interface: api/interface.md
      - Projects: api/project.md
      - Session Cache: api/sessioncache.md
      - Utils: api/utils.md
  - Contributing: contributing.md
  - Changelog: changelog.md