Skip to content

Commit b32c9d0

Browse files
RicardoRynRicardoRyn
committed
docs: remove emojis from README and navigation items
1 parent 223446c commit b32c9d0

5 files changed

Lines changed: 281 additions & 296 deletions

File tree

‎.codegraph/.gitignore‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ notebooks/*
1616
tests/test.py
1717
.codegraph/*
1818
.understand-anything/*
19+
.codegraph/*

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ A Python visualization library designed for cognitive neuroscience research, pro
1616

1717
## Features
1818

19-
- 📊 **Multiple Chart Types**: Bar charts, matrix plots, correlation plots, circos plots, brain surface plots, brain connectivity plots
20-
- 🎨 **Professional Research Style**: Built-in color schemes that meet academic publication standards
21-
- 📈 **Automatic Significance Testing**: Built-in statistical methods with automatic significance annotations
22-
- 🔬 **Designed for Neuroscience**: Supports common primate brain atlases and brain network visualization
23-
- 🚀 **Easy to Use**: Simple API for quick getting started
19+
- **Multiple Chart Types**: Bar charts, matrix plots, correlation plots, circos plots, brain surface plots, brain connectivity plots
20+
- **Professional Research Style**: Built-in color schemes that meet academic publication standards
21+
- **Automatic Significance Testing**: Built-in statistical methods with automatic significance annotations
22+
- **Designed for Neuroscience**: Supports common primate brain atlases and brain network visualization
23+
- **Easy to Use**: Simple API for quick getting started
2424

2525
## Quick Start
2626

‎zensical.toml‎

Lines changed: 137 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,137 +1,137 @@
1-
[project]
2-
site_name = "plotfig"
3-
site_description = "A Python package for scientific plotting in cognitive neuroscience research."
4-
site_author = "Ricardo Ryn"
5-
6-
site_url = "https://ricardoryn.github.io/plotfig/"
7-
docs_dir = "docs/en"
8-
9-
repo_url = "https://github.com/RicardoRyn/plotfig/"
10-
repo_name = "RicardoRyn/plotfig"
11-
edit_uri = "edit/main/docs/en/"
12-
13-
copyright = """
14-
Copyright © 2026 Ricardo Ryn
15-
"""
16-
nav = [
17-
{ "🧭 Introduction" = "index.md" },
18-
{ "📦 Installation" = "installation.md" },
19-
{ "🔄 Changelog" = "changelog.md" },
20-
{ "🚀 Usage" = [
21-
"usage/single_group.md",
22-
"usage/multi_groups.md",
23-
"usage/matrix.md",
24-
"usage/correlation.md",
25-
"usage/circos.md",
26-
"usage/brain_surface.md",
27-
"usage/brain_connectivity.md"
28-
]},
29-
{ "🔌 API" = "api/index.md" }
30-
]
31-
32-
[project.theme]
33-
language = "en"
34-
features = [
35-
"announce.dismiss",
36-
"content.action.edit",
37-
"content.action.view",
38-
"content.code.annotate",
39-
"content.code.copy",
40-
"content.code.select",
41-
"content.footnote.tooltips",
42-
"content.tabs.link",
43-
"content.tooltips",
44-
# "header.autohide",
45-
"navigation.expand",
46-
"navigation.footer",
47-
"navigation.indexes",
48-
"navigation.instant",
49-
"navigation.instant.prefetch",
50-
# "navigation.instant.progress",
51-
# "navigation.path",
52-
# "navigation.prune",
53-
# "navigation.sections",
54-
# "navigation.tabs",
55-
# "navigation.tabs.sticky",
56-
"navigation.top",
57-
"navigation.tracking",
58-
"search.highlight",
59-
# "toc.follow",
60-
#"toc.integrate",
61-
]
62-
63-
# Palette toggle for automatic mode
64-
[[project.theme.palette]]
65-
media = "(prefers-color-scheme)"
66-
toggle.icon = "lucide/sun-moon"
67-
toggle.name = "Switch to light mode"
68-
69-
# Palette toggle for light mode
70-
[[project.theme.palette]]
71-
media = "(prefers-color-scheme: light)"
72-
scheme = "default"
73-
toggle.icon = "lucide/sun"
74-
toggle.name = "Switch to dark mode"
75-
76-
# Palette toggle for dark mode
77-
[[project.theme.palette]]
78-
media = "(prefers-color-scheme: dark)"
79-
scheme = "slate"
80-
toggle.icon = "lucide/moon"
81-
toggle.name = "Switch to system preference"
82-
83-
[project.theme.icon]
84-
edit = "material/pencil"
85-
view = "material/eye"
86-
87-
[project.extra]
88-
alternate = [
89-
{ name = "English", link = "/plotfig/", lang = "en" },
90-
{ name = "中文", link = "/plotfig/zh/", lang = "zh" }
91-
]
92-
93-
[[project.extra.social]]
94-
icon = "fontawesome/brands/github"
95-
link = "https://github.com/RicardoRyn"
96-
97-
[[project.extra.social]]
98-
icon = "fontawesome/brands/gitee"
99-
link = "https://gitee.com/RicardoRyn"
100-
101-
[project.plugins.mkdocstrings.handlers.python]
102-
inventories = ["https://docs.python.org/3/objects.inv"]
103-
paths = ["src"]
104-
105-
[project.plugins.mkdocstrings.handlers.python.options]
106-
docstring_style = "google"
107-
show_source = true
108-
# DOCSTRINGS -------------------------------------------------------------
109-
docstring_options.ignore_init_summary = true
110-
# docstring_section_style = "list"
111-
# CROSS-REFERENCES -------------------------------------------------------
112-
relative_crossrefs = true # Sponsors only!
113-
scoped_crossrefs = true # Sponsors only!
114-
signature_crossrefs = true
115-
unwrap_annotated = true
116-
# MEMBERS ----------------------------------------------------------------
117-
filters = "public" # Sponsors only!
118-
inherited_members = true
119-
summary = true
120-
# HEADINGS ---------------------------------------------------------------
121-
# heading_level = 1
122-
# parameter_headings = true
123-
# type_parameter_headings = true
124-
show_root_heading = true
125-
show_root_full_path = false
126-
show_symbol_type_heading = true
127-
show_symbol_type_toc = true
128-
# SIGNATURES -------------------------------------------------------------
129-
# line_length = 88
130-
merge_init_into_class = true
131-
separate_signature = true
132-
show_signature_annotations = true
133-
show_signature_type_parameters = true
134-
# OTHER ------------------------------------------------------------------
135-
backlinks = "tree"
136-
show_bases = false
137-
show_inheritance_diagram = true
1+
[project]
2+
site_name = "plotfig"
3+
site_description = "A Python package for scientific plotting in cognitive neuroscience research."
4+
site_author = "Ricardo Ryn"
5+
6+
site_url = "https://ricardoryn.github.io/plotfig/"
7+
docs_dir = "docs/en"
8+
9+
repo_url = "https://github.com/RicardoRyn/plotfig/"
10+
repo_name = "RicardoRyn/plotfig"
11+
edit_uri = "edit/main/docs/en/"
12+
13+
copyright = """
14+
Copyright © 2026 Ricardo Ryn
15+
"""
16+
nav = [
17+
{ "Introduction" = "index.md" },
18+
{ "Installation" = "installation.md" },
19+
{ "Changelog" = "changelog.md" },
20+
{ "Usage" = [
21+
"usage/single_group.md",
22+
"usage/multi_groups.md",
23+
"usage/matrix.md",
24+
"usage/correlation.md",
25+
"usage/circos.md",
26+
"usage/brain_surface.md",
27+
"usage/brain_connectivity.md"
28+
]},
29+
{ "🔌 API" = "api/index.md" }
30+
]
31+
32+
[project.theme]
33+
language = "en"
34+
features = [
35+
"announce.dismiss",
36+
"content.action.edit",
37+
"content.action.view",
38+
"content.code.annotate",
39+
"content.code.copy",
40+
"content.code.select",
41+
"content.footnote.tooltips",
42+
"content.tabs.link",
43+
"content.tooltips",
44+
# "header.autohide",
45+
"navigation.expand",
46+
"navigation.footer",
47+
"navigation.indexes",
48+
"navigation.instant",
49+
"navigation.instant.prefetch",
50+
# "navigation.instant.progress",
51+
# "navigation.path",
52+
# "navigation.prune",
53+
# "navigation.sections",
54+
# "navigation.tabs",
55+
# "navigation.tabs.sticky",
56+
"navigation.top",
57+
"navigation.tracking",
58+
"search.highlight",
59+
# "toc.follow",
60+
#"toc.integrate",
61+
]
62+
63+
# Palette toggle for automatic mode
64+
[[project.theme.palette]]
65+
media = "(prefers-color-scheme)"
66+
toggle.icon = "lucide/sun-moon"
67+
toggle.name = "Switch to light mode"
68+
69+
# Palette toggle for light mode
70+
[[project.theme.palette]]
71+
media = "(prefers-color-scheme: light)"
72+
scheme = "default"
73+
toggle.icon = "lucide/sun"
74+
toggle.name = "Switch to dark mode"
75+
76+
# Palette toggle for dark mode
77+
[[project.theme.palette]]
78+
media = "(prefers-color-scheme: dark)"
79+
scheme = "slate"
80+
toggle.icon = "lucide/moon"
81+
toggle.name = "Switch to system preference"
82+
83+
[project.theme.icon]
84+
edit = "material/pencil"
85+
view = "material/eye"
86+
87+
[project.extra]
88+
alternate = [
89+
{ name = "English", link = "/plotfig/", lang = "en" },
90+
{ name = "中文", link = "/plotfig/zh/", lang = "zh" }
91+
]
92+
93+
[[project.extra.social]]
94+
icon = "fontawesome/brands/github"
95+
link = "https://github.com/RicardoRyn"
96+
97+
[[project.extra.social]]
98+
icon = "fontawesome/brands/gitee"
99+
link = "https://gitee.com/RicardoRyn"
100+
101+
[project.plugins.mkdocstrings.handlers.python]
102+
inventories = ["https://docs.python.org/3/objects.inv"]
103+
paths = ["src"]
104+
105+
[project.plugins.mkdocstrings.handlers.python.options]
106+
docstring_style = "google"
107+
show_source = true
108+
# DOCSTRINGS -------------------------------------------------------------
109+
docstring_options.ignore_init_summary = true
110+
# docstring_section_style = "list"
111+
# CROSS-REFERENCES -------------------------------------------------------
112+
relative_crossrefs = true # Sponsors only!
113+
scoped_crossrefs = true # Sponsors only!
114+
signature_crossrefs = true
115+
unwrap_annotated = true
116+
# MEMBERS ----------------------------------------------------------------
117+
filters = "public" # Sponsors only!
118+
inherited_members = true
119+
summary = true
120+
# HEADINGS ---------------------------------------------------------------
121+
# heading_level = 1
122+
# parameter_headings = true
123+
# type_parameter_headings = true
124+
show_root_heading = true
125+
show_root_full_path = false
126+
show_symbol_type_heading = true
127+
show_symbol_type_toc = true
128+
# SIGNATURES -------------------------------------------------------------
129+
# line_length = 88
130+
merge_init_into_class = true
131+
separate_signature = true
132+
show_signature_annotations = true
133+
show_signature_type_parameters = true
134+
# OTHER ------------------------------------------------------------------
135+
backlinks = "tree"
136+
show_bases = false
137+
show_inheritance_diagram = true

0 commit comments

Comments
 (0)