MemNNetSim/mkdocs.yml at main · marcus-k/MemNNetSim · 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
site_name: MemNNetSim

repo_url: https://github.com/marcus-k/MemNNetSim
repo_name: marcus-k/MemNNetSim

theme:
  name: material
  palette:
    - scheme: default
      primary: blue grey
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue grey
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  logo: assets/icons/mnns-icon-light.svg
  features:
    - search.suggest
    - content.code.copy
    - navigation.sections
    - navigation.indexes
    - navigation.instant

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_section_style: table # or "table"
            docstring_style: "numpy"
            filters: ["!^_"]
            heading_level: 1
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            summary: true
  - api-autonav:
      modules: ["mnns"]
      nav_section_title: Reference
      exclude:
        - mnns.typing
        - mnns.version
  - macros

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Installation: installation.md
  - Usage: usage.md
  - Examples: examples.md
  - Reference:
    - NWN Attributes: attributes.md

not_in_nav: |
  examples/

watch:
  - mnns