mappingtools/zensical.toml at main · erivlis/mappingtools · GitHub

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
[project]
copyright = "Copyright &copy; 2025 Eran Rivlis"
site_name = "MappingTools"
site_author = "Eran Rivlis"
site_description = ""
repo_url = "https://github.com/erivlis/mappingtools"
repo_name = "erivlis/mappingtools"
license = "https://github.com/erivlis/mappingtools/LICENSE"
extra_css = [
    "stylesheets/extra.css"
]
nav = [
    { Start = [
        "index.md",
        "installation.md",
        "overview.md"
    ] },
    { Guide = [
        "guide/collectors.md",
        "guide/operators.md",
        "guide/optics.md",
        "guide/structures.md",
        "guide/transformers.md"
    ] },
    { Recipes = "recipes.md" },
    { Reference = "reference.md" },
    { Development = [
        "design_decisions.md",
        "development_guide.md",
        "contributing.md",
        "acknowledgements.md"
    ] }
]


[project.theme]
variant = "classic"
font.text = "Inter"
font.code = "JetBrains Mono"
language = "en"
logo = "images/logo.png"
favicon = "images/logo.png"
features = [
    "content.code.copy",
    "content.code.select",
    "navigation.footer",
    "navigation.instant",
    "navigation.instant.prefetch",
    "navigation.instant.progress",
    "navigation.path",
    "navigation.sections",
    #    "navigation.tabs",
    "navigation.top",
    "navigation.tracking",
    "toc.follow",
]


#[project.extra]
#social = [
#    { icon = "fontawesome/brands/github", link = "https://github.com/erivlis/mappingtools" },
#    { icon = "fontawesome/brands/x-twitter", link = "https://x.com/erivlis" },
#    { icon = "fontawesome/solid/envelope", link = "mailto:eran@rivlis.info" },
#    { icon = "fontawesome/solid/mastodon", link = "https://mastodon.social/@erivlis" }
#]

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/erivlis"
[[project.extra.social]]
icon = "fontawesome/brands/x-twitter"
link = "https://x.com/erivlis"
[[project.extra.social]]
icon = "fontawesome/brands/mastodon"
link = "https://mastodon.social/@erivlis"
[[project.extra.social]]
icon = "fontawesome/brands/bluesky"
link = "https://bsky.app/@erivlis"
[[project.extra.social]]
icon = "fontawesome/brands/linkedin"
link = "https://www.linkedin.com/in/eranrivlis/"
[[project.extra.social]]
icon = "fontawesome/solid/at"
link = "mailto:eran@rivlis.info"

# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"

[project.plugins.mkdocstrings.handlers.python]
inventories = ["https://docs.python.org/3/objects.inv"]
paths = ["src"]

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
inherited_members = true
show_source = false

[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji" # (1)!
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true

[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.superfences]

[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true

[project.markdown_extensions.toc]
permalink = true
toc_depth = 3