SUQ/mkdocs.yml at main · AaltoML/SUQ · 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
site_name: SUQ.py
site_url: https://AaltoML.github.io/SUQ # change this

repo_url: https://github.com/AaltoML/SUQ
repo_name: AaltoML/SUQ

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github  # optional, for GitHub icon

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: false
            show_root_members: true
            show_root_toc_entry: false
            heading_level: 3
            group_by_category: true
            show_category_heading: true
            members_order: source

nav:
  - Home: index.md
  - API Reference: reference.md