-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
76 lines (71 loc) · 2.01 KB
/
mkdocs.yml
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
76
site_name: Netboxcli
repo_url: https://github.com/Kaioguilherme1/netbox-client
repo_name: Kaioguilherme1/netbox-client
edit_uri: tree/main/docs/
theme:
name: material
language: pt-BR
features:
- search.suggest
- content.code.annotate
- content.code.copy
- content.code.select
- content.action.edit
- toc.follow
- content.tooltips
- navigation.indexes
- navigation.path
- navigation.footer
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to system preference
markdown_extensions:
- tables
- attr_list
- admonition
- pymdownx.details
- pymdownx.tasklist
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
plugins:
- termynal
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [netboxcli]
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
options:
show_signature_annotations: true
show_root_toc_entry: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_source: false
signature_crossrefs: false
show_bases: true
summary: true
annotations_path: brief
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Kaioguilherme1