plotfig/zensical.toml at main · RicardoRyn/plotfig · 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
[project]
site_name = "plotfig"
site_description = "A Python package for scientific plotting in cognitive neuroscience research."
site_author = "Ricardo Ryn"

site_url = "https://ricardoryn.github.io/plotfig/"
docs_dir = "docs/en"

repo_url = "https://github.com/RicardoRyn/plotfig/"
repo_name = "RicardoRyn/plotfig"
edit_uri = "edit/main/docs/en/"

copyright = """
Copyright &copy; 2026 Ricardo Ryn
"""
nav = [
    { "🧭 Introduction" = "index.md" },
    { "📦 Installation" = "installation.md" },
    { "🔄 Changelog" = "changelog.md" },
    { "🚀 Usage" = [
      "usage/single_group.md",
      "usage/multi_groups.md",
      "usage/matrix.md",
      "usage/correlation.md",
      "usage/circos.md",
      "usage/brain_surface.md",
      "usage/brain_connectivity.md"
    ]},
    { "🔌 API" = "api/index.md" }
]

[project.theme]
language = "en"
features = [
    "announce.dismiss",
    "content.action.edit",
    "content.action.view",
    "content.code.annotate",
    "content.code.copy",
    "content.code.select",
    "content.footnote.tooltips",
    "content.tabs.link",
    "content.tooltips",
    # "header.autohide",
    "navigation.expand",
    "navigation.footer",
    "navigation.indexes",
    "navigation.instant",
    "navigation.instant.prefetch",
    # "navigation.instant.progress",
    # "navigation.path",
    # "navigation.prune",
    # "navigation.sections",
    # "navigation.tabs",
    # "navigation.tabs.sticky",
    "navigation.top",
    "navigation.tracking",
    "search.highlight",
    # "toc.follow",
    #"toc.integrate",
]

# 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.theme.icon]
edit = "material/pencil"
view = "material/eye"

[project.extra]
alternate = [
    { name = "English", link = "/plotfig/", lang = "en" },
    { name = "中文", link = "/plotfig/zh/", lang = "zh" }
]

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/RicardoRyn"

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

[project.plugins.mkdocstrings.handlers.python.options]
docstring_style = "google"
show_source = true
# DOCSTRINGS -------------------------------------------------------------
docstring_options.ignore_init_summary = true
# docstring_section_style = "list"
# CROSS-REFERENCES -------------------------------------------------------
relative_crossrefs = true  # Sponsors only!
scoped_crossrefs = true  # Sponsors only!
signature_crossrefs = true
unwrap_annotated = true
# MEMBERS ----------------------------------------------------------------
filters = "public"  # Sponsors only!
inherited_members = true
summary = true
# HEADINGS ---------------------------------------------------------------
# heading_level = 1
# parameter_headings = true
# type_parameter_headings = true
show_root_heading = true
show_root_full_path = false
show_symbol_type_heading = true
show_symbol_type_toc = true
# SIGNATURES -------------------------------------------------------------
# line_length = 88
merge_init_into_class = true
separate_signature = true
show_signature_annotations = true
show_signature_type_parameters = true
# OTHER ------------------------------------------------------------------
backlinks = "tree"
show_bases = false
show_inheritance_diagram = true