generated from potassco/python-project-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
136 lines (128 loc) · 4.13 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
site_name: mkdoclingo
site_url: https://potassco.org/systems/mkdoclingo
site_description:
repo_name: potassco/mkdoclingo
repo_url: https://github.com/potassco/mkdoclingo
copyright: Copyright © 2024 Potassco
extra_css:
- _custom/css/extra.css
- _custom/css/mkdocstrings.css
- _custom/css/mkdoclingo.css
extra_javascript:
- _custom/javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
theme:
name: material
logo: assets/images/potassco-logo.svg
custom_dir: docs/_custom/overrides
favicon: assets/images/potassco-logo-dark.svg
features:
- header.autohide
- navigation.instant
- navigation.tracking
# - navigation.sections
- navigation.indexes
- content.code.annotate
# - toc.integrate
- toc.follow
- navigation.path
# - navigation.top
- navigation.tabs
- content.code.copy
- content.tooltips
# - navigation.instant.preview
# - navigation.expand
icon:
repo: fontawesome/brands/github
admonition:
quote: material/file-code-outline
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode
primary: custom #, [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]
accent: indigo # [red, pink, purple, deep, purple, indigo, blue, light, blue, cyan, teal, green, light, green, lime, yellow, amber, orange, deep orange]
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom #, [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]
accent: indigo # [red, pink, purple, deep, purple, indigo, blue, light, blue, cyan, teal, green, light, green, lime, yellow, amber, orange, deep orange]
toggle:
icon: material/weather-sunny
name: Switch to light mode
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/potassco/mkdoclingo
- icon: potassco-logo
link: https://potassco.org
generator: false
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.keys
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- _custom/overrides/.icons
- attr_list
- md_in_html
- pymdownx.blocks.caption
- pymdownx.snippets
- pymdownx.arithmatex:
generic: true
- toc:
permalink: true
- footnotes
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
paths: [src]
import:
- https://docs.python.org/3/objects.inv
options:
show_symbol_type_heading: true
show_symbol_type_toc: true
# show_root_toc_entry: false
# show_inherited_summary: true
show_inherited_detail: true
show_inherited_detail_toc: true
show_inherited_detail_tree: true
show_signature_annotations: true
signature_crossrefs: true
show_source: false
nav:
# - Home: index.md
- Getting Started:
- Installation: installation.md
- Usage: usage.md
- Examples:
- examples/index.md
- examples/sudoku.md
- Reference:
- reference/index.md
- Problem: reference/problem/index.md
- Encodings: reference/encodings/index.md
- API: reference/api/index.md
- Community:
- community/index.md
- Help: community/help.md
- Changes: community/CHANGES.md
- Contributing: community/CONTRIBUTING.md
- Development: community/DEVELOPMENT.md
- Deployment: community/DEPLOYMENT.md