pyromark/mkdocs.yml at main · monosans/pyromark · 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
site_name: pyromark
site_url: https://monosans.github.io/pyromark
strict: true
repo_url: https://github.com/monosans/pyromark
repo_name: monosans/pyromark
edit_uri: edit/main/docs/
nav:
  - index.md
  - install.md
  - api.md
  - cli.md
  - performance.md
theme:
  features:
    - content.action.edit
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.prune
    - navigation.top
    - toc.follow
  icon:
    logo: fontawesome/brands/markdown
    repo: fontawesome/brands/github
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: lucide/sun
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: lucide/moon
        name: Switch to light mode
extra:
  social:
    - icon: fontawesome/brands/telegram
      link: https://t.me/monosans
      name: Developer's Telegram
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/monosans
      name: Developer's LinkedIn
markdown_extensions:
  - pymdownx.superfences
  - toc:
      permalink: true
plugins:
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://typing-extensions.readthedocs.io/en/stable/objects.inv
          options:
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters:
              - "!^_(?:[^_].*[^_]|_(?:all|doc|format|main|module|new|slots|str)__)$"
            members_order: source
            merge_init_into_class: true
            parameter_headings: true
            separate_signature: true
            show_if_no_docstring: true
            show_signature_annotations: true
            show_source: false
            show_submodules: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            type_parameter_headings: true