Skip to content

Commit 86d4dc4

Browse files
VisLabVisLab
authored
Merge pull request #35 from VisLab/format_corrections
Updated the format for table-remodeler
2 parents a240651 + 5b78205 commit 86d4dc4

4 files changed

Lines changed: 170 additions & 13 deletions

File tree

‎docs/_static/custom.css‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,67 @@
11
/* Custom styles for Table Remodeler Documentation - Furo Theme */
22

3+
/* Project name styling below logo */
4+
.sidebar-brand-text {
5+
font-size: 1.5rem !important;
6+
font-weight: 600 !important;
7+
color: #0969da !important;
8+
margin-top: 0.5rem !important;
9+
text-align: center !important;
10+
}
11+
12+
html[data-theme="dark"] .sidebar-brand-text,
13+
body[data-theme="dark"] .sidebar-brand-text {
14+
color: #58a6ff !important;
15+
}
16+
17+
/* Make all heading levels match sidebar title blue color */
18+
.content h1,
19+
.content h2,
20+
.content h3,
21+
.content h4,
22+
.content h5,
23+
.content h6,
24+
article h1,
25+
article h2,
26+
article h3,
27+
article h4,
28+
article h5,
29+
article h6 {
30+
color: #0969da !important;
31+
}
32+
33+
body[data-theme="dark"] .content h1,
34+
body[data-theme="dark"] .content h2,
35+
body[data-theme="dark"] .content h3,
36+
body[data-theme="dark"] .content h4,
37+
body[data-theme="dark"] .content h5,
38+
body[data-theme="dark"] .content h6,
39+
body[data-theme="dark"] article h1,
40+
body[data-theme="dark"] article h2,
41+
body[data-theme="dark"] article h3,
42+
body[data-theme="dark"] article h4,
43+
body[data-theme="dark"] article h5,
44+
body[data-theme="dark"] article h6 {
45+
color: #58a6ff !important;
46+
}
47+
48+
@media (prefers-color-scheme: dark) {
49+
body:not([data-theme="light"]) .content h1,
50+
body:not([data-theme="light"]) .content h2,
51+
body:not([data-theme="light"]) .content h3,
52+
body:not([data-theme="light"]) .content h4,
53+
body:not([data-theme="light"]) .content h5,
54+
body:not([data-theme="light"]) .content h6,
55+
body:not([data-theme="light"]) article h1,
56+
body:not([data-theme="light"]) article h2,
57+
body:not([data-theme="light"]) article h3,
58+
body:not([data-theme="light"]) article h4,
59+
body:not([data-theme="light"]) article h5,
60+
body:not([data-theme="light"]) article h6 {
61+
color: #58a6ff !important;
62+
}
63+
}
64+
365
/* Quick Links sidebar styling - darker gray box with proper padding */
466
.sidebar-quicklinks {
567
margin: 1rem 0.75rem 1rem 0.75rem;
@@ -9,12 +71,49 @@
971
border: 1px solid #d0d0d0;
1072
}
1173

74+
/* Style RST sidebar directive boxes to match left sidebar styling */
75+
.sidebar,
76+
aside.sidebar {
77+
background-color: #e8e8e8 !important;
78+
border: 1px solid #d0d0d0 !important;
79+
border-radius: 0.25rem !important;
80+
padding: 0.75rem 1rem !important;
81+
}
82+
83+
body[data-theme="dark"] .sidebar,
84+
body[data-theme="dark"] aside.sidebar {
85+
background-color: #0d0d0d !important;
86+
border-color: #1a1a1a !important;
87+
}
88+
89+
@media (prefers-color-scheme: dark) {
90+
body:not([data-theme="light"]) .sidebar,
91+
body:not([data-theme="light"]) aside.sidebar {
92+
background-color: #0d0d0d !important;
93+
border-color: #1a1a1a !important;
94+
}
95+
}
96+
97+
.sidebar p.sidebar-title,
98+
aside.sidebar p.sidebar-title {
99+
font-weight: 600 !important;
100+
margin-bottom: 0.5rem !important;
101+
}
102+
12103
/* Dark mode styling for quick links - much darker background */
13104
body[data-theme="dark"] .sidebar-quicklinks {
14105
background-color: #0d0d0d;
15106
border-color: #1a1a1a;
16107
}
17108

109+
/* Auto mode with dark system preference */
110+
@media (prefers-color-scheme: dark) {
111+
body:not([data-theme="light"]) .sidebar-quicklinks {
112+
background-color: #0d0d0d;
113+
border-color: #1a1a1a;
114+
}
115+
}
116+
18117
.sidebar-quicklinks h3 {
19118
margin-top: 0;
20119
margin-bottom: 0.5rem;
@@ -77,6 +176,16 @@ body[data-theme="dark"] .sidebar-search-container input {
77176
background-image: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23cccccc' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E") !important;
78177
}
79178

179+
/* Auto mode with dark system preference */
180+
@media (prefers-color-scheme: dark) {
181+
body:not([data-theme="light"]) .sidebar-search-container input {
182+
background-color: #0d0d0d !important;
183+
border: 1px solid #1a1a1a !important;
184+
color: #e8e8e8 !important;
185+
background-image: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24' fill='none' stroke='%23cccccc' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Ccircle cx='11' cy='11' r='8'%3E%3C/circle%3E%3Cline x1='21' y1='21' x2='16.65' y2='16.65'%3E%3C/line%3E%3C/svg%3E") !important;
186+
}
187+
}
188+
80189
/* Make search icon visible */
81190
.sidebar-search-container input::placeholder {
82191
color: var(--color-foreground-muted) !important;

‎docs/_templates/quicklinks.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ <h3>Quick links</h3>
66
<li><a href="https://www.hedtags.org/hed-schema-browser" target="_blank">HED schema browser</a></li>
77
<li><a href="https://www.hedtags.org/hed-specification" target="_blank">HED specification</a></li>
88
<li><a href="https://hedtools.org/hed" target="_blank">HED online tools</a></li>
9+
<li><a href="https://www.hedtags.org/hed-python" target="_blank">Python HEDTools</a></li>
910
</ul>
1011
</div>

‎docs/conf.py‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9-
project = "Remodeler"
9+
project = "Table Remodeler"
1010
copyright = "2024, HED Standard"
1111
author = "HED Standard"
1212

@@ -20,6 +20,7 @@
2020
"sphinx.ext.autodoc",
2121
"sphinx.ext.autosummary",
2222
"sphinx.ext.napoleon",
23+
"sphinx.ext.viewcode",
2324
"sphinx.ext.intersphinx",
2425
"myst_parser",
2526
"sphinx_copybutton",
@@ -55,7 +56,7 @@
5556
"source_directory": "docs/",
5657
}
5758

58-
html_title = "Remodeler"
59+
html_title = "Table Remodeler"
5960

6061
# Configure sidebar to show logo, search, navigation, and quick links
6162
html_sidebars = {

‎docs/index.rst‎

Lines changed: 57 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,64 @@
1-
Table remodeler documentation
2-
=============================
1+
Table Remodeler
2+
===============
33

4-
Welcome to the Table Remodeler documentation. This package provides tools for remodeling and reorganizing tabular data files, particularly event files used in neuroimaging research.
4+
5+
.. sidebar:: Quick links
6+
7+
* `HED homepage <https://www.hedtags.org/>`_
8+
9+
* `HED vocabularies <https://www.hedtags.org/hed-schema-browser>`_
10+
11+
* `HED online tools <https://hedtools.org/hed/>`_
12+
13+
* `HED browser tools <https://www.hedtags.org/hed-javascript>`_
14+
15+
* `HED organization <https://github.com/hed-standard/>`_
16+
17+
* `HED specification <https://www.hedtags.org/hed-specification>`_
18+
19+
Welcome to the Table Remodeler documentation! This package provides comprehensive tools for remodeling and reorganizing tabular data files, particularly event files used in neuroimaging and behavioral research.
20+
21+
What is Table Remodeler?
22+
-------------------------
23+
24+
Table Remodeler is a flexible, operation-based framework for transforming tabular data through JSON-configurable pipelines. It's designed for preprocessing event files, reorganizing datasets, and generating summaries, with special support for **HED (Hierarchical Event Descriptors)** annotations.
25+
26+
Key features
27+
------------
28+
29+
* **Flexible operations**: Chain multiple transformations in JSON-based pipelines
30+
* **HED integration**: Full support for HED-annotated data validation and analysis
31+
* **BIDS compatibility**: Works seamlessly with BIDS dataset structures
32+
* **Backup & restore**: Safe data transformations with built-in versioning
33+
* **Extensible**: Easy to create custom operations for specific needs
34+
35+
Getting started
36+
---------------
537

638
.. toctree::
739
:maxdepth: 2
8-
:caption: Contents:
9-
10-
introduction
11-
quickstart
12-
user_guide
13-
operations/index
14-
custom_operations
15-
api/index
40+
41+
Introduction <introduction>
42+
Quick start <quickstart>
43+
44+
Working with Table Remodeler
45+
-----------------------------
46+
47+
.. toctree::
48+
:maxdepth: 2
49+
50+
User guide <user_guide>
51+
Operations reference <operations/index>
52+
Custom operations <custom_operations>
53+
54+
API documentation
55+
-----------------
56+
57+
.. toctree::
58+
:maxdepth: 2
59+
60+
API reference <api/index>
61+
1662

1763
Indices and tables
1864
==================

0 commit comments

Comments
 (0)