exputils/mkdocs.yml at master · ChrisReinke/exputils · 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
site_name: Exputils Docs

theme:
  name: material
  icon:
    logo: material/tools
  palette:
      primary: blue

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_symbol_type_toc: false
            parameter_headings: false
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_docstring_parameters: true
            show_signature: false
            heading_level: 3

nav:
  - Welcome: index.md
  - Installation: install.md
  - Tutorial: tutorials.md
  - Reference:
      - Overview: reference/overview.md
      - Manage: reference/manage.md
      - Logging: reference/logging.md
      - Visualization: reference/visualization.md
      - Loading: reference/loading.md
      - IO: reference/io.md

markdown_extensions:
  - attr_list
  # allow emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  # images
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - md_in_html
  - pymdownx.blocks.caption
  # set level of table of contents
  - toc:
      baselevel: "1"
      toc_depth: "3"

extra_css:
  - stylesheets/extra.css