-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
160 lines (131 loc) · 3.86 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
# Copyright (c) 2023 Anthony Mugendi
#
# This software is released under the MIT License.
# https://opensource.org/licenses/MIT
site_name: wraptimer
copyright: Copyright © 2023 Red Hat, Inc.
site_url: https://mugendi.github.io/wraptimer/
repo_url: https://github.com/mugendi/wraptimer
edit_uri: blob/main/docs/
docs_dir: docs
# navigation bar
nav:
- index.md
- timer.md
- timeit.md
# Watch
watch:
- mkdocs.yml
- wraptimer
- docs
- README.md
# Theme
# https://squidfunk.github.io/mkdocs-material/reference/
theme:
name: ansible
highlightjs: true
# https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/
palette:
# can be either "default, red, pink, purple, deep purple, indigo, blue, light blue, cyan, teal, green, light green, lime, yellow, amber, orange, deep orange, brown, grey, blue grey, black, white"
- primary: indigo
features:
- content.code.copy
- content.action.edit
- navigation.expand
- navigation.sections
- navigation.instant
- navigation.indexes
- navigation.tracking
- toc.integrate
- content.tooltips
icon:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
# Plugins
plugins:
- autorefs
- material/search
- material/social
- material/tags
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
options:
# heading_level: 2
docstring_style: sphinx
docstring_options:
ignore_init_summary: yes
show_submodules: yes
docstring_section_style: list
members_order: alphabetical
show_category_heading: no
# cannot merge init into class due to parse error...
# merge_init_into_class: yes
show_root_heading: yes
show_signature_annotations: yes
separate_signature: yes
show_bases: false
# markdown extensions
# https://facelessuser.github.io/pymdown-extensions/#extensions
markdown_extensions:
- markdown_include.include:
base_path: docs
- def_list
- footnotes
- pymdownx.emoji
- pymdownx.highlight:
anchor_linenums: true
linenums : true
auto_title: false
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
social_url_shortener: true
user: facelessuser
repo: pymdown-extensions
normalize_issue_symbols: true
- pymdownx.tabbed:
alternate_style: true
- toc:
toc_depth: 4
permalink: true
- pymdownx.superfences
# https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/
- pymdownx.tasklist:
custom_checkbox: true
# Used to highlight added, deleted or updated sections in a document
# https://facelessuser.github.io/pymdown-extensions/extensions/critic/
- pymdownx.critic
# https://facelessuser.github.io/pymdown-extensions/extensions/betterem/
- pymdownx.betterem
# https://facelessuser.github.io/pymdown-extensions/extensions/keys/
# ++ctrl+alt+delete++
- pymdownx.keys
# abbreviations and snippets
# https://squidfunk.github.io/mkdocs-material/reference/tooltips/#mkdocsyml
- abbr
- attr_list
- pymdownx.snippets:
auto_append:
- docs/includes/abbreviations.md
# Admonitions
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/?h=admonition#octicons
- admonition
extra_css:
- styles/extra.css