-
-
Notifications
You must be signed in to change notification settings - Fork 55
/
Copy pathmkdocs.yml
executable file
·132 lines (130 loc) · 4.19 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
site_name: Proxbox Docs
site_dir: ./site
site_url: https://proxbox.netbox.dev.br/
docs_dir: ./docs
repo_name: netdevopsbr/netbox-proxbox
repo_url: https://github.com/netdevopsbr/netbox-proxbox
theme:
name: material
custom_dir: docs/_theme/
icon:
repo: fontawesome/brands/github
language: en
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
accent: deep-orange
toggle:
icon: material/lightbulb-outline
name: Switch to Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/lightbulb
name: Switch to Light Mode
features:
- navigation.instant
- navigation.tracking
- search.suggest
- search.highlight
- navigation.footer
- navigation.path
- navigation.top
- toc.follow
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_typingdoc
show_bases: true
#show_root_heading: true
show_if_no_docstring: true
inherited_members: true
#members_order: source
#separate_signature: true
#unwrap_annotated: true
#merge_init_into_class: true
#docstring_section_style: spacy
#signature_crossrefs: true
nav:
- Proxbox: index.md
- Installation:
- Pre-Installation: 'installation/pre-installation.md'
- Installing the Plugin:
- Using pip (recommended): 'installation/1-installing-plugin.md'
- Using git: 'installation/2-installing-plugin-git.md'
- Using Docker: 'installation/3-installing-plugin-docker.md'
- Backend Setup:
- Using pip (recommended): 'backend/using-pip.md'
- Using git: 'backend/using-git.md'
- Using Docker: 'backend/using-docker.md'
# - Backend (FastAPI): 'backend/index.md'
# - Source Code:
# - 'src/netboxbasic.md'
# - Installing & Upgrade:
# - Installing Proxbox: 'installation/index.md'
# - Upgrading Proxbox: 'installation/upgrading.md'
# - Features:
# - Virtual Machine (VM): 'features/virtual-machine.md'
# - Containers (LXC): 'features/containers.md'
# - Network (IPAM): 'features/network.md'
# - VLAN Management: 'features/vlan-management.md'
# - Storage: 'features/storage.md'
# - Backup: 'features/backup.md'
# - Monitoring: 'features/monitoring.md'
# - Synchronized Data: 'features/synchronized-data.md'
# - Background Jobs: 'features/background-jobs.md'
# - API & Integration: 'features/api-integration.md'
# - Configuration:
# - Configuring ProxBox: 'configuration/index.md'
# - Required Parameters: 'configuration/required-parameters.md'
# - Data Model:
# - Virtual Machine (VM): 'models/virtual-machine.md'
# - Containers (LXC): 'models/containers.md'
# - Others: 'models/others.md'
# - Release Notes:
# - Summary: 'release-notes/index.md'
# - Version 0.0.6: 'release-notes/version-0.0.1.md'
# - Version 0.0.5: 'release-notes/version-0.0.1.md'
# - Version 0.0.4: 'release-notes/version-0.0.1.md'
# - Version 0.0.3: 'release-notes/version-0.0.1.md'
# - Version 0.0.2: 'release-notes/version-0.0.1.md'
# - Version 0.0.1: 'release-notes/version-0.0.1.md'
extra:
homepage: https://netboxlabs.com
extra_css:
- https://cdn.materialdesignicons.com/5.4.55/css/materialdesignicons.min.css
- extra.css
markdown_extensions:
- attr_list
- def_list
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- admonition
- abbr
- toc:
permalink: true
toc_depth: 4
- tables
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
extra_javascript:
- 'https://cdn.jsdelivr.net/npm/@material-icons/iconfont/material-icons.min.js'