mmlearn/mkdocs.yml at main · VectorInstitute/mmlearn · 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
extra_css:
  - stylesheets/extra.css
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/VectorInstitute/mmlearn
markdown_extensions:
  - attr_list
  - admonition
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
nav:
  - Home: index.md
  - Installation: installation.md
  - User Guide: user_guide.md
  - API Reference: api.md
  - Contributing: contributing.md
plugins:
  - search
  - autorefs
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            members_order: source
            separate_signature: true
            show_overloads: true
            show_submodules: true
            show_root_heading: false
            show_root_full_path: true
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
repo_url: https://github.com/VectorInstitute/mmlearn
repo_name: VectorInstitute/mmlearn
site_name: mmlearn
theme:
  custom_dir: docs/overrides
  favicon: assets/favicon-48x48.svg
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: assets/vector-logo.svg
  logo_footer: assets/vector-logo.svg
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: vector
      accent: vector-teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: vector-teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode