xarray-sql/zensical.toml at main · xqlsystems/xarray-sql · 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
140
141
142
[project]
site_name = "xarray-sql"
site_description = "Query Xarray with SQL"
site_author = "Alexander Merose"
site_url = "https://xqlsystems.github.io/xarray-sql/"
repo_url = "https://github.com/xqlsystems/xarray-sql"
repo_name = "xqlsystems/xarray-sql"
edit_uri = "edit/main/docs/"
nav = [
  {"Home" = "index.md"},
  {"Getting started" = "examples.md"},
  {"Concepts" = [
    {"Engines" = "engines.md"},
  ]},
  {"Guides" = [
    {"Geospatial in SQL" = "geospatial.md"},
    {"Performance" = "performance.md"},
  ]},
  {"Reference" = [
    {"API" = "reference/xarray_sql.md"},
    {"Known issues" = "limitations.md"},
    {"Contributing" = "contributing.md"},
  ]}
]

# Theme configuration
[project.theme]
variant = "modern"
logo = "assets/logo.svg"
features = [
  "announce.dismiss",
  "content.action.edit",
  "content.action.view",
  "content.code.annotate",
  "content.code.copy",
  "content.tooltips",
  "navigation.footer",
  "navigation.indexes",
  "navigation.instant",
  "navigation.instant.prefetch",
  "navigation.instant.progress",
  "navigation.sections",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  "search.share",
  "search.suggest",
  "toc.follow"
]

# Color palette - light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "custom"
accent = "blue"

[project.theme.palette.toggle]
icon = "material/brightness-7"
name = "Switch to dark mode"

# Color palette - dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "custom"
accent = "black"

[project.theme.palette.toggle]
icon = "material/brightness-4"
name = "Switch to light mode"

# Markdown extensions
[project.markdown_extensions.toc]
permalink = true

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

[project.markdown_extensions.pymdownx.superfences]
[[project.markdown_extensions.pymdownx.superfences.custom_fences]]
name = "mermaid"
class = "mermaid"
format = "pymdownx.superfences.fence_code_format"

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

[project.markdown_extensions.pymdownx.inlinehilite]

[project.markdown_extensions.admonition]

[project.markdown_extensions.footnotes]

[project.markdown_extensions.pymdownx.snippets]
url_download = true
base_path = ["."]

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

[project.markdown_extensions.pymdownx.emoji]
emoji_index = "zensical.extensions.emoji.twemoji"
emoji_generator = "zensical.extensions.emoji.to_svg"

[project.markdown_extensions.attr_list]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.abbr]

[project.markdown_extensions.def_list]

# Plugins
[project.plugins]
search = {}
typeset = {}

[project.plugins.mkdocstrings.handlers.python]
paths = ["."]

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
show_if_no_docstring = true
filters = ["!^_"]

# Extra configuration
[project.extra]

# Versioned docs via mike (Zensical fork); versions live on the gh-pages branch
[project.extra.version]
provider = "mike"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/xqlsystems/xarray-sql"

[[project.extra.social]]
icon = "fontawesome/brands/python"
link = "https://pypi.org/project/xarray-sql"