docs: Furo theme + TCRi branding (docs site + README logo)

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://github.com/nceglia/tcri/blob/main/tcri_logo.png?raw=true" alt="TCRi logo" width="500">
+  <img src="https://github.com/nceglia/tcri/blob/main/tcri_logo.png?raw=true" alt="TCRi logo" width="400">
 </p>
 
 # **TCR**i

docs/_static/css/custom.css

@@ -1,26 +1,48 @@
-/* Custom styles for TCRi documentation */
+/* TCRi documentation — minimal aesthetic with the brand green (#39de2d) as a
+   strong accent. Layered on top of Furo; base colors (white background, near-
+   black text, dark greys, green links) come from light_css_variables /
+   dark_css_variables in conf.py. Everything here is mode-safe: it only sets
+   the bright-green accents and weights, never a fixed foreground/background
+   color, so light and dark modes both stay readable. */
 
-/* Main content area */
-.wy-nav-content {
-    max-width: 1200px;
+:root {
+  --tcri-green: #39de2d;
 }
 
-/* Code blocks */
-.highlight {
-    background: #f5f5f5;
+/* Sidebar wordmark logo. */
+.sidebar-logo {
+  max-height: 3rem;
+  width: auto;
+}
+.sidebar-logo-container {
+  margin: 0.7rem 0 0.3rem;
 }
 
-/* Links */
-a {
-    color: #2980B9;
+/* Headings: bold, with bright-green accent rules. Color is inherited from the
+   theme foreground so it adapts between light and dark. */
+h1, h2, h3, h4, h5, h6 {
+  font-weight: 700;
+  letter-spacing: -0.01em;
+}
+h1 {
+  border-bottom: 3px solid var(--tcri-green);
+  padding-bottom: 0.2rem;
+}
+h2 {
+  border-bottom: 1px solid rgba(57, 222, 45, 0.5);
+  padding-bottom: 0.15rem;
 }
 
-a:hover {
-    color: #3091d1;
+/* Green accent bars on admonitions and API signatures. */
+.admonition {
+  border-left: 4px solid var(--tcri-green);
+}
+dl.py > dt {
+  border-left: 3px solid var(--tcri-green);
+  padding-left: 0.6rem;
 }
 
-/* Headers */
-h1, h2, h3, h4, h5, h6 {
-    font-family: 'Roboto', sans-serif;
-    color: #2c3e50;
+/* Tables: green header rule. */
+table.docutils thead tr {
+  border-bottom: 2px solid var(--tcri-green);
 }

docs/conf.py

@@ -60,7 +60,7 @@ def _get_release():
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 # Add any paths that contain custom static files (such as style sheets) here.
 # relative to this directory. They are copied after the builtin static files,
@@ -73,20 +73,30 @@ def _get_release():
     'css/custom.css',
 ]
 
-html_logo = '../framework.png'
-html_favicon = '../framework.png'
+html_favicon = '_static/favicon.ico'
 
+# -- Furo theme --------------------------------------------------------------
+# Minimal, white-background look with the TCRi brand green (#39de2d) as the
+# accent. The wordmark logo serves as the title, so the text name is hidden.
+# Bright #39de2d is used for non-text accents (heading rules, nav marker,
+# admonition bars) via custom.css; body link text uses a darker green
+# (#1f9e16) that stays readable on white.
 html_theme_options = {
-    'logo_only': False,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
-    'style_nav_header_background': '#2980B9',
-    # Toc options
-    'collapse_navigation': True,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "sidebar_hide_name": True,
+    "light_logo": "tcri_logo.svg",
+    "dark_logo": "tcri_logo_dark.svg",
+    "light_css_variables": {
+        "color-brand-primary": "#1f9e16",
+        "color-brand-content": "#1f9e16",
+        "color-brand-visited": "#1f9e16",
+        "color-background-primary": "#ffffff",
+        "color-foreground-primary": "#0a0a0a",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#39de2d",
+        "color-brand-content": "#39de2d",
+        "color-brand-visited": "#39de2d",
+    },
 }
 
 # -- Extension configuration -------------------------------------------------

docs/requirements.txt

@@ -5,7 +5,7 @@
 # here. Only the Sphinx toolchain plus numpy/pandas (kept real for clean
 # intersphinx type links) are needed.
 sphinx>=7,<9
-sphinx-rtd-theme>=2.0
+furo>=2024.1.29
 myst-parser>=2.0
 numpy
 pandas