MapManager-Docs/mkdocs.yml at main · mapmanager/MapManager-Docs · 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
site_name: MapManager
site_description: Dendritic Spine Analysis
site_author: Robert H Cudmore (plust others)

# NEW: Tell MkDocs where the site lives
# site_url: https://mapmanager.github.io/MapManager-Docs/
site_url: https://mapmanager.net/

repo_name: MapManager-Docs
repo_url: https://github.com/mapmanager/MapManager-Docs
edit_uri: ""

theme:
    name: material
    custom_dir: 'theme'
    palette:
        # Palette toggle for automatic mode
        - media: "(prefers-color-scheme)"
          toggle:
            icon: material/brightness-auto
            name: Switch to light mode
        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: slate
          primary: indigo
          accent: indigo
          toggle:
            icon: material/brightness-7
            name: Switch to dark mode
        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: indigo
          accent: indigo
          toggle:
            icon: material/brightness-4
            name: Switch to system preference
    features:
        - navigation.instant
        #- navigation.expand

extra_css:
  - css/style.css
  - theme/css/style.css
  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.0/css/all.min.css

watch:
  - .

markdown_extensions:
  - pymdownx.superfences
  # to allow tabs in markdown
  - pymdownx.tabbed:
      alternate_style: true
  #
  - admonition
  - pymdownx.details
  # allow links to open in a new tab, use [MapManagerCore Documentation](https://mapmanager.net/MapManagerCore/){target="_blank"}
  - attr_list
  # allows emojis, we will use this for icons to show links open in new tab
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: false  # default false
            show_root_toc_entry: true  # default true
            show_category_heading: true
            group_by_category: true  # default true
            heading_level: 2  # default 2
            #show_object_full_path: true
            show_submodules: false
            show_source: true
            # docstring_style: numpy
            docstring_style: google
            docstring_section_style: table  # table, list, spacey
            show_signature_annotations: true  # true is a little to verbose, false is not verbose enough
            # show_root_heading: true

nav:
    - Getting Started: getting-started.md
    - Supported File Formats: supported-file-formats.md
    - API:
        - MapManager Core: mapmanagercore.md