dect/mkdocs.yml at main · aidos-lab/dect · 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
site_name: DECT - Differentiable Euler Characteristic Transform

theme:
  name: material
  favicon: assets/favico.ico
  logo: assets/favico.ico
  features:
    - navigation.sections
    - header.autohide
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      toggle:
        icon: material/weather-night
        name: switch to dark mode 🌙
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      toggle:
        icon: material/weather-sunny
        name: switch to light mode 🌞

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [dect,.]
          options:
            docstring_style: google
            docstring_section_style: list
  - mkdocs-autoapi:
      autoapi_dir: dect
      autoapi_add_nav_entry: Reference
      autoapi_ignore:
        - "**/lorem.py"
      autoapi_file_patterns:
        - "*.py"

markdown_extensions:
  - markdown_include.include:
      base_path: docs
  - pymdownx.extra
  - pymdownx.highlight
  - pymdownx.details
  - pymdownx.saneheaders
  - pymdownx.smartsymbols
  - pymdownx.critic:
      mode: view
  - pymdownx.snippets
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.superfences
  - pymdownx.emoji
  - admonition
  - meta
  - toc:
      permalink: true

nav:
  - index.md
  - installation.md
  - Tutorials:
    - Example computation: notebooks/00_example_computation.md
    - Example Usage: notebooks/01_example_usage.md
    - Learning Directions: notebooks/02_learning_directions.md
  - About:
    - License: license.md
    - Contribute: contribute.md
    - Website: website.md