vantage/mkdocs.yml at master · chizhang24/vantage · 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
# Project Information
site_name: Vantage Documentation
site_url: https://vantageproject.org
site_description: 'Documentation for Vantage: A large, verified mathematical knowledge base in Lean 4'

# Repository
repo_url: https://github.com/justincasher/vantage
repo_name: 'vantage'          # Name displayed for the link
edit_uri: 'edit/master/docs/' # Allows direct links to edit pages on GitHub (adjust 'main' if your branch is different)

# Theme Configuration (using mkdocs-material)
theme:
  name: material
  logo: images/favicon.png
  favicon: images/favicon.png
  features:
    - navigation.tabs     # Use top-level sections as tabs
    - navigation.sections # Expand sections in the side navigation
    - navigation.top      # Back-to-top button
    - search.suggest      # Autocomplete suggestions in search
    - search.highlight    # Highlight search terms on results page
    - content.code.annotate # Allows code annotations
    - content.code.copy   # Copy button for code blocks
    - header.autohide     # Automatically hide the header
  palette: # Allow light/dark mode toggle
    - scheme: default     # Default light mode
      primary: deep purple
      accent: deep blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate       # Default dark mode
      primary: deep purple
      accent: deep blue
      toggle:
        icon: material/brightness-2
        name: Switch to light mode

# Navigation Structure (Manually defining API Reference)
nav:
  - 'Welcome': 'index.md'
  - 'Getting Started':
    - 'Installation & Setup': 'getting-started/index.md' #
    - 'Configuration': 'getting-started/configuration.md'
    - 'Usage': 'getting-started/usage.md'
  - 'API Reference':
    - 'Overview': 'reference/index.md'
    - 'KB Search': 'reference/kb_search.md'
    - 'KB Storage': 'reference/kb_storage.md'
    - 'LaTeX Processor': 'reference/latex_processor.md'
    - 'Lean Interaction': 'reference/lean_interaction.md'
    - 'Lean Processor': 'reference/lean_processor.md'
    - 'Lean Proof Repair': 'reference/lean_proof_repair.md'
    - 'LLM Call': 'reference/llm_call.md'
  - 'Contributing':
    - 'How to Contribute': 'contributing/index.md'
    - 'Testing': 'contributing/testing.md'
    - 'Coding Style': 'contributing/coding_style_guidelines.md'
    - 'Code of Conduct': 'contributing/code_of_conduct.md'

# Markdown Extensions (Enable extra formatting features)
markdown_extensions:
  - admonition           # Adds nice colored boxes for notes, warnings, etc.
  - pymdownx.details     # Collapsible sections
  - pymdownx.superfences # Allows nesting code blocks, diagrams, etc.
  - pymdownx.highlight:  # Code highlighting configuration
      anchor_linenums: true
  - pymdownx.inlinehilite # Inline code highlighting
  - pymdownx.snippets    # Include parts of other files
  - pymdownx.tabbed:     # Tabbed content blocks
      alternate_style: true
  - toc:                 # Table of contents generation
      permalink: true    # Add links to headings

# Plugins Configuration
plugins:
  - search # Built-in search plugin
  - gen-files: # Generates files before build
      scripts:
        - scripts/gen_ref_pages.py
  - mkdocstrings: # Renders docstrings from Python code
      handlers:
        python: # Using the Python handler
          options:
            # --- Core Parsing Options ---
            docstring_style: google          # Sets the expected docstring format (e.g., google, numpy, sphinx).

            # --- Member Rendering Control ---
            members_order: source            # Order members (functions, classes) as they appear in the source code file.
            show_docstring_functions: true   # Render the full docstring body for functions and methods.
            show_docstring_classes: true     # Render the full docstring body for classes.
            # Note: Options like show_docstring_parameters, _raises, _attributes, _description, etc., default to true.

            # --- Presentation and Organization ---
            show_root_heading: true          # Add a top-level heading for the object being documented (e.g., the module name).
            show_category_heading: true      # Add category headings like "Functions", "Classes" when listing members.
            group_by_category: true          # Group listed members by their category (functions together, classes together).
            show_bases: true                 # For classes, show the base classes they inherit from.
            show_signature_annotations: true # Include type hints (annotations) in the rendered function/method signatures.