ioc_cleanup/zensical.toml at master · oceanmodeling/ioc_cleanup · 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
[project]
site_name = "IOC Cleanup"
site_url = "https://tomsail.github.io/ioc_cleanup/"

docs_dir = "docs"
site_dir = "site"

nav = [
  {"Home" = "index.md"},
  {"Concept" = "concept.md"},
  {"Reference" = [
    {"JSONs" = "reference/json-schema.md"},
    {"Data Architecture" = "reference/data-layout.md"},
    {"API" = "reference/python-api.md"},
  ]},
  {"Dashboard" = [
    {"Usage" = "workflows/dashboard.md"},
  ]},
  {"Guidelines" = "guidelines.md"},
  {"Contributing" = "contributing.md"},
]

[project.theme]
features = [
    "navigation.tabs",
    "navigation.path",
    "navigation.top",
    "toc.integrate",
    "content.code.copy"
]

[project.theme.icon]
logo = "material/waves"


# 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"
primary = "teal"
accent = "teal"
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"
primary = "teal"
accent = "teal"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"

# admonitions
[project.markdown_extensions.admonition]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.superfences]

# lists
[project.markdown_extensions.def_list]
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

# emojis
[project.markdown_extensions.attr_list]
[project.markdown_extensions.pymdownx.emoji]

# code snippets
[project.markdown_extensions.pymdownx.highlight]
anchor_linenums = true
line_spans = "__span"
pygments_lang_class = true
[project.markdown_extensions.pymdownx.snippets]
[project.markdown_extensions.pymdownx.inlinehilite]

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

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
signature_crossrefs = true
show_source = true
show_signature = true
show_docstring_description= true
show_root_heading= true
show_symbol_type_heading = true
heading_level = 3