-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
121 lines (112 loc) · 3.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
site_name: DP3
site_url: https://cesnet.github.io/dp3/
site_description: Dynamic Profile Processing Platform
repo_name: CESNET/dp3
repo_url: https://github.com/CESNET/dp3
theme:
name: material
logo: img/dp3-logo-min.svg
favicon: img/dp3-favicon.png
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
# Copy code blocks
- content.code.copy
# Code annotations
- content.code.annotate
extra_css:
- stylesheets/slate.css
nav:
- Overview: index.md
- Install: install.md
- Architecture: architecture.md
- Data model: data_model.md
- History Management: history_management.md
- API: api.md
- Modules: modules.md
- Configuration:
- configuration/index.md
- API: configuration/api.md
- Control: configuration/control.md
- Database: configuration/database.md
- Database entities: configuration/db_entities.md
- Entity Lifetimes: configuration/lifetimes.md
- Event logging: configuration/event_logging.md
- History manager: configuration/history_manager.md
- Modules: configuration/modules.md
- Processing core: configuration/processing_core.md
- Snapshots: configuration/snapshots.md
- Garbage Collector: configuration/garbage_collector.md
- Updater: configuration/updater.md
- Code Reference: reference/
- Scripts: scripts.md
- Grafana plugin: grafana_plugin.md
- Extending Documentation: extending.md
markdown_extensions:
# Adds option to create permalinks to headings
- toc:
permalink: True
# Code blocks
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
# Markdown checkboxes
- pymdownx.tasklist:
# Admonitions
- admonition
- pymdownx.details
- pymdownx.superfences
# Additional attribute lists (used e.g. for image size)
- attr_list
- md_in_html
# Strike-through
- pymdownx.tilde
plugins:
# Default search bar
- search
# Automatically link across pages
- autorefs
# Generating code reference
- gen-files:
scripts:
- docs/gen_ref_pages.py
# Specify navigation in Markown instead of YAML
- literate-nav:
nav_file: SUMMARY.md
# Clickable sections that lead to index pages
- section-index
# Docstring parsing to fill code reference
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
options:
docstring_style: google
show_root_heading: true
show_root_full_path: true
members_order: source
docstring_section_style: table
merge_init_into_class: true
show_signature_annotations: true
separate_signature: true
watch:
- dp3