UniEnv/mkdocs.yml at main · UniEnvOrg/UniEnv · 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
site_name: UniEnv
site_description: Unified robot environment framework documentation
site_url: https://unienvorg.github.io/UniEnv/
repo_url: https://github.com/UniEnvOrg/UniEnv
repo_name: UniEnvOrg/UniEnv

theme:
  name: material
  features:
    - navigation.instant
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - content.code.copy
    - search.highlight
    - search.suggest

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths:
            - .
          options:
            filters:
              - "!^_"
            heading_level: 2
            inherited_members: true
            members_order: source
            merge_init_into_class: true
            separate_signature: true
            show_if_no_docstring: true
            show_root_full_path: false
            show_root_heading: false
            show_signature_annotations: true
            show_source: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true