suthing/mkdocs.yml at main · growgraph/suthing · 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
site_name: suthing
site_url: https://growgraph.github.io/suthing/
repo_url: https://github.com/growgraph/suthing
repo_name: growgraph/suthing
copyright: Copyright &copy; 2025 GrowGraph

theme:
    name: material
    user_color_mode_toggle: true
    palette:
    -   scheme: default
        primary: indigo
        accent: deep purple
        toggle:
            icon: material/toggle-switch-off-outline
            name: Switch to dark mode
    -   scheme: slate
        primary: blue grey
        accent: amber
        toggle:
            icon: material/toggle-switch
            name: Switch to light mode
    icon:
        repo: fontawesome/brands/github
    favicon: assets/favicon.ico
  # logo: assets/logo.png

plugins:
-   search
-   mkdocstrings:
        default_handler: python
        handlers:
            python:
                options:
                    extra:
                        show_source: true
                        show_root_toc_entry: false
                        docstring_style: google
                        show_submodules: true
                        show_category_heading: true
                        show_if_no_docstring: true
                        setup_commands:
                        -   "import sys"
                        -   "sys.path.append('.')"
          # selection:
          #   docstring_style: google
          #   inherited_members: true
          #   filters: ["!^_"]

nav:
-   Home: index.md
-   Getting Started:
    -   Installation: getting_started/installation.md
    -   Quick Start: getting_started/quickstart.md
  # - Features:
  #   - File Handling: features/file_handling.md
  #   - Performance Measurement: features/performance.md
  #   - Data Comparison: features/comparison.md
  #   - Error Handling: features/error_handling.md
-   API Reference:
    -   Overview: reference/index.md
    -   Core: reference/core.md
-   Examples: examples.md
-   Contributing: contributing.md

markdown_extensions:
-   pymdownx.highlight:
        anchor_linenums: true
        line_spans: __span
        pygments_lang_class: true
-   pymdownx.inlinehilite
-   pymdownx.snippets
-   pymdownx.superfences
-   attr_list
-   md_in_html
-   admonition
-   codehilite
-   footnotes
-   meta
-   toc:
        permalink: true