-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
152 lines (144 loc) · 3.87 KB
/
mkdocs.yml
File metadata and controls
152 lines (144 loc) · 3.87 KB
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
site_name: unwrappy
site_url: https://leodiegues.github.io/unwrappy
site_description: Rust-inspired Result and Option types for Python - safe, expressive error handling with errors as values
site_author: Leonardo Diegues
repo_name: leodiegues/unwrappy
repo_url: https://github.com/leodiegues/unwrappy
edit_uri: edit/main/docs/
copyright: Copyright © 2024 Leonardo Diegues
theme:
name: material
custom_dir: docs/overrides
logo: assets/logo.svg
favicon: assets/logo.svg
palette:
# Light mode - Sharp Solarized (sepia/rust tones)
- media: "(prefers-color-scheme: light)"
scheme: solarized-light
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode - Solarized Dark with rust accents
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- content.tabs.link
- toc.follow
icon:
repo: fontawesome/brands/github
extra_css:
- stylesheets/extra.css
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/leodiegues/unwrappy
- icon: fontawesome/brands/python
link: https://pypi.org/project/unwrappy/
generator: false
markdown_extensions:
# Python Markdown
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
# PyMdown Extensions
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
auto_append:
- includes/abbreviations.md
- 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
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [src]
options:
docstring_style: google
docstring_section_style: spacy
show_root_heading: true
show_root_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
show_signature_annotations: true
separate_signature: true
signature_crossrefs: true
merge_init_into_class: true
show_if_no_docstring: false
- social:
cards_layout_options:
background_color: "#b58900"
color: "#fdf6e3"
nav:
- Home: index.md
- Getting Started: getting-started.md
- Guide:
- guide/index.md
- Result Type: guide/result.md
- Option Type: guide/option.md
- Lazy Evaluation: guide/lazy-evaluation.md
- Serialization: guide/serialization.md
- API Reference:
- api/index.md
- Result: api/result.md
- Option: api/option.md
- Examples: examples.md
- Architecture: architecture.md
- Contributing: contributing.md