-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
181 lines (169 loc) · 4.56 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# Project Information
site_name: rite
site_url: https://www.pyrites.dev/
site_description: Python Utility Package
site_author: Scape Agency
lang: en
# Repository
repo_name: 'GitHub'
repo_url: https://github.com/scape-agency/rite/
edit_uri_template: 'docs/{path}'
dev_addr: 127.0.0.1:8888
# Copyright
copyright: >
Copyright © 2023 <a href="https://www.scape.agency">Scape Agency BV</a>. All Rights Reserved.
# hide:
# - footer
# Configuration
theme:
name: material
custom_dir: 'docs/overrides'
locale: en
language: en
palette:
scheme: scapeagency
# palette:
# - scheme: default
# primary: indigo
# accent: indigo
# toggle:
# icon: material/brightness-7
# name: Switch to dark mode
# - scheme: slate
# primary: indigo
# accent: indigo
# toggle:
# icon: material/brightness-4
# name: Switch to light mode
# font:
# text: 'Manrope'
# code: 'Roboto Mono'
logo: assets/image/logo_light.png
favicon: assets/favicon/favicon.ico
features:
# - announce.dismiss
# - content.action.edit
# - content.action.view
# - content.code.annotate
# - content.code.copy
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.prune
# - navigation.sections
# - navigation.tabs
# - navigation.tabs.sticky
# - navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
# Plugins
plugins:
- search:
lang: en
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- mkdocstrings:
# custom_templates: templates
default_handler: python
handlers:
python:
options:
# Heading options
heading_level: 2
show_root_heading: false
show_root_toc_entry: false
show_root_full_path: false
show_root_members_full_path: false
show_object_full_path: false
show_category_heading: false
# Additional options
show_bases: true
show_source: false
# Customization
extra:
generator: false
analytics:
provider: google
property: G-49589BK5M9
social:
- icon: fontawesome/solid/globe
link: https://www.scape.agency
- icon: fontawesome/brands/github
link: https://github.com/scape-agency/
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/scape-agency/
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/scape.agency/
- icon: fontawesome/brands/facebook
link: https://www.facebook.com/scape.agency/
# consent:
# title: Cookie consent
# description: >-
# We use cookies to recognize your repeated visits and preferences, as well
# as to measure the effectiveness of our documentation and whether users
# find what they're searching for. With your consent, you're helping us to
# make our documentation better.
extra_css:
- assets/style/extra.css
extra_javascript:
- assets/script/extra.js
extra_templates:
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
# - toc:
# permalink: true
# - pymdownx.arithmatex:
# generic: true
# - pymdownx.betterem:
# smart_enable: all
# - pymdownx.caret
# - pymdownx.details
# - pymdownx.emoji:
# emoji_generator: !!python/name:materialx.emoji.to_svg
# emoji_index: !!python/name:materialx.emoji.twemoji
# - pymdownx.highlight:
# anchor_linenums: true
# - pymdownx.inlinehilite
# - pymdownx.keys
# - pymdownx.magiclink:
# repo_url_shorthand: true
# user: squidfunk
# repo: mkdocs-material
# - pymdownx.mark
# - pymdownx.smartsymbols
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# class: mermaid
# format: !!python/name:pymdownx.superfences.fence_code_format
# - pymdownx.tabbed:
# alternate_style: true
# - pymdownx.tasklist:
# custom_checkbox: true
# - pymdownx.tilde
# Page tree
nav:
- Introduction: 'index.md'
- Quick Start: 'quick_start.md'
- Resources:
- 'Glossary': 'resources/glossary.md'
- 'Links': 'resources/links.md'
- About:
- 'Authors': 'about/authors.md'
- Legal Information:
- 'License': 'legal/license.md'
- 'Privacy Policy': 'legal/privacy_policy.md'
- 'Disclaimer': 'legal/disclaimer.md'