simplipy/mkdocs.yml at main · psaegert/simplipy · 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
# Project information
site_name: SimpliPy
site_author: Paul Saegert
repo_url: https://github.com/psaegert/simplipy
repo_name: psaegert/simplipy
edit_uri: blob/main/

# Theme configuration
theme:
  name: material
  palette:
    # Light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.instant
    - navigation.path
    - navigation.prune
    - navigation.indexes
    - search.suggest
    - search.highlight

# Extensions for better rendering
markdown_extensions:
  - toc:
      permalink: true
  - attr_list
  - footnotes
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: True
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.arithmatex:
      generic: true

nav:
  - API-Reference: api.md
  - Creating Rulesets: rules.md

# Plugin configurations
plugins:
  - search
  - autorefs
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: numpy
            merge_init_into_class: True
            show_bases: false
            heading_level: 2 # This is a global default
            docstring_section_style: spacy
            show_signature_annotations: true
            separate_signature: true
            show_root_heading: false
            members_order: source
            show_source: true