python-template/mkdocs.yml at main · sbgaia/python-template · 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
site_name: project_name
site_description: A simple template project.
repo_name: python-template
theme:
  name: material
  features:
  - navigation.sections
  - navigation.indexes
  - content.code.copy
  - search.suggest
  - search.highlight

plugins:
- search
- mkdocstrings:
    handlers:
      python:
        options:
          docstring_style: google
          heading_level: 2
          show_root_heading: true
          show_root_full_path: false
          show_root_toc_entry: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          separate_signature: true
          show_signature_annotations: true
          merge_init_into_class: true
          inherited_members: true
          members_order: source

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

markdown_extensions:
- admonition
- attr_list
- tables
- toc:
    permalink: true
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences