Skip to content

Commit f16d9c2

Browse files
committed
basic zensical support
1 parent 7e4d2c4 commit f16d9c2

2 files changed

Lines changed: 59 additions & 0 deletions

File tree

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ dependencies = [
3636
"numpy>=1.26,<3",
3737
"matplotlib>=3.8,<4",
3838
"pydantic>=2.6,<3",
39+
"zensical>=0.0.38",
3940
]
4041

4142
dynamic = ["version"]

zensical.toml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
[project]
2+
site_name = "plaid"
3+
site_description = "PLAID documentation"
4+
site_author = "Safran"
5+
copyright = "Copyright © Safran"
6+
7+
# Build from the existing Sphinx source folder.
8+
docs_dir = "docs/source"
9+
site_dir = "docs/_build/zensical"
10+
11+
# Minimal navigation focused on Markdown pages that already exist in docs/source.
12+
nav = [
13+
{ "Quickstart" = "quickstart.md" },
14+
{ "Citation" = "citation.md" },
15+
{ "Contributing" = "contributing.md" },
16+
{ "Core concepts" = [
17+
{ "Sample" = "core_concepts/sample.md" },
18+
{ "Dataset" = "core_concepts/dataset.md" },
19+
{ "Problem definition" = "core_concepts/problem_definition.md" },
20+
{ "Defaults" = "core_concepts/defaults.md" },
21+
{ "Disk format" = "core_concepts/disk_format.md" },
22+
{ "Interoperability" = "core_concepts/interoperability.md" },
23+
]
24+
},
25+
{ "Tutorials" = [
26+
{ "Storage" = "tutorials/storage.md" },
27+
]
28+
},
29+
]
30+
31+
[project.theme]
32+
language = "en"
33+
34+
[[project.theme.palette]]
35+
scheme = "default"
36+
toggle.icon = "lucide/sun"
37+
toggle.name = "Switch to dark mode"
38+
39+
[[project.theme.palette]]
40+
scheme = "slate"
41+
toggle.icon = "lucide/moon"
42+
toggle.name = "Switch to light mode"
43+
44+
[project.markdown_extensions.admonition]
45+
[project.markdown_extensions.attr_list]
46+
[project.markdown_extensions.def_list]
47+
[project.markdown_extensions.footnotes]
48+
[project.markdown_extensions.md_in_html]
49+
[project.markdown_extensions.tables]
50+
[project.markdown_extensions.toc]
51+
permalink = true
52+
53+
[project.markdown_extensions.pymdownx.details]
54+
[project.markdown_extensions.pymdownx.superfences]
55+
[project.markdown_extensions.pymdownx.tabbed]
56+
alternate_style = true
57+
[project.markdown_extensions.pymdownx.tasklist]
58+
custom_checkbox = true

0 commit comments

Comments
 (0)