-
Notifications
You must be signed in to change notification settings - Fork 4
/
mkdocs.yml
145 lines (125 loc) · 3.29 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
site_name: Safe-DS Python Library
repo_url: https://github.com/Safe-DS/Library
repo_name: Safe-DS/Library
edit_uri: edit/main/docs/
site_url: !ENV READTHEDOCS_CANONICAL_URL
strict: true
nav:
- Home:
- README.md
- Changelog: CHANGELOG.md
- Tutorials:
- Data Processing: tutorials/data_processing.ipynb
- Image processing: tutorials/image_processing.ipynb
- Data Visualization: tutorials/data_visualization.ipynb
- Classification: tutorials/classification.ipynb
- Regression: tutorials/regression.ipynb
- Machine Learning: tutorials/machine_learning.ipynb
- API Reference: reference/
- Glossary: glossary.md
- Development:
- Environment: development/environment.md
- Project Guidelines: development/project_guidelines.md
- Code Review Guide: development/code_review.md
- Contributing 🌐: https://github.com/Safe-DS/Library/contribute
# Configuration of MkDocs & Material for MkDocs --------------------------------
theme:
name: material
logo: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/safe-ds_logo_rounded.svg
favicon: https://raw.githubusercontent.com/Safe-DS/.github/main/branding/safe-ds_logo_rounded.svg
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
primary: indigo
accent: indigo
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
primary: black
accent: indigo
features:
- content.code.copy
- content.tabs.link
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.top
plugins:
- mkdocstrings:
handlers:
python:
paths:
- src
options:
docstring_style: numpy
show_if_no_docstring: true
- gen-files:
scripts:
- docs/reference/generate_reference_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- autorefs
- glightbox
- search
- mkdocs-jupyter:
include: ["*.ipynb"]
execute: true
allow_errors: false
- exclude:
glob:
- "*.csv"
- "*.py"
watch:
- src
markdown_extensions:
# Admonitions
- admonition
- pymdownx.details
# Code blocks
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
# Diagrams
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# Footnotes
- footnotes
# Keys
- pymdownx.keys
# Icons & emojis
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
# Images
- attr_list
- md_in_html
# Lists
- def_list
- pymdownx.tasklist:
custom_checkbox: true
# MathJax
- pymdownx.arithmatex:
generic: true
# Permalinks
- toc:
permalink: true
# Tabs
- pymdownx.tabbed:
alternate_style: true
extra_css:
- stylesheets/jupyter.css
extra_javascript:
- javascript/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js