WIP

Author: spoorcc

doc/_ext/dfetch_style.py

@@ -0,0 +1,64 @@
+"""Custom Pygments style matching the dfetch website brand palette."""
+
+import sys
+import types
+
+import pygments.styles
+from pygments.style import Style
+from pygments.token import (
+    Comment,
+    Error,
+    Generic,
+    Keyword,
+    Name,
+    Number,
+    Operator,
+    String,
+    Token,
+)
+
+
+class DfetchStyle(Style):
+    """Brand-matched Pygments style — mirrors the website palette."""
+
+    background_color = "#fef8f0"  # --bg-tint
+    default_style = ""
+    styles = {
+        Token: "#1c1917",  # --text
+        Comment: "italic #78716c",  # --text-muted
+        Comment.Preproc: "noitalic #a0510a",  # --primary-dark
+        Keyword: "bold #c2620a",  # --primary
+        Keyword.Pseudo: "nobold #c2620a",
+        Operator: "#a0510a",  # --primary-dark
+        Operator.Word: "bold #c2620a",
+        String: "#4a7a62",  # --dxt-reference (sage)
+        String.Doc: "italic #4a7a62",
+        Number: "#7a5a9a",  # --dxt-explanation (purple)
+        Name.Builtin: "#4e7fa0",  # --accent
+        Name.Builtin.Pseudo: "#4e7fa0",
+        Name.Class: "bold #4e7fa0",
+        Name.Function: "#3a6682",  # --accent-dark
+        Name.Exception: "bold #c0544a",  # --dferror
+        Name.Decorator: "#78716c",  # --text-muted
+        Name.Tag: "bold #c2620a",  # --primary
+        Name.Attribute: "#4e7fa0",  # --accent
+        Generic.Heading: "bold #1c1917",
+        Generic.Subheading: "bold #78716c",
+        Generic.Deleted: "#c0544a",  # --dferror
+        Generic.Inserted: "#4a7a62",  # sage green
+        Generic.Error: "#c0544a",
+        Generic.Emph: "italic",
+        Generic.Strong: "bold",
+        Generic.Prompt: "bold #c2620a",  # --primary
+        Generic.Output: "#78716c",  # --text-muted
+        Generic.Traceback: "#4e7fa0",  # --accent
+        Error: "border:#c0544a",
+    }
+
+
+def register() -> None:
+    """Inject the style into Pygments so it can be looked up by name."""
+    mod = types.ModuleType("pygments.styles.dfetch")
+    mod.DfetchStyle = DfetchStyle  # type: ignore[attr-defined]
+    sys.modules["pygments.styles.dfetch"] = mod
+    pygments.styles.STYLE_MAP["dfetch"] = "dfetch::DfetchStyle"

doc/conf.py

@@ -14,6 +14,14 @@
 import sys
 from importlib.metadata import PackageNotFoundError, version
 
+# _ext/ must be on sys.path before any local imports.
+ext_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))
+sys.path.insert(0, ext_path)
+
+import dfetch_style
+
+dfetch_style.register()
+
 try:
     __version__ = version("dfetch")
 except PackageNotFoundError:
@@ -26,9 +34,6 @@
 
 # -- General configuration ------------------------------------------------
 
-ext_path = os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext"))
-sys.path.insert(0, ext_path)
-
 # If your documentation needs a minimal Sphinx version, state it here.
 #
 # needs_sphinx = '1.0'
@@ -106,7 +111,7 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "venv", "landing-page"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = "dfetch"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False

doc/dfetch_preamble.inc

@@ -96,26 +96,31 @@
 \tcbuselibrary{skins}
 \usepackage{etoolbox}
 \tcbset{
-  dfnote/.style={enhanced, frame hidden,
-    borderline west={3.5pt}{0pt}{dfaccent}, colback=dfbgmint,
-    left=10pt, right=10pt, top=8pt, bottom=8pt,
+  dfnote/.style={enhanced,
+    leftrule=3.5pt, rightrule=0pt, toprule=0pt, bottomrule=0pt,
+    colframe=dfaccent, colback=dfbgmint,
+    arc=4pt, left=10pt, right=10pt, top=8pt, bottom=8pt,
     before skip=\baselineskip, after skip=0.5\baselineskip},
-  dfwarn/.style={enhanced, frame hidden,
-    borderline west={3.5pt}{0pt}{dfprimary}, colback=dfbgtint,
-    left=10pt, right=10pt, top=8pt, bottom=8pt,
+  dfwarn/.style={enhanced,
+    leftrule=3.5pt, rightrule=0pt, toprule=0pt, bottomrule=0pt,
+    colframe=dfprimary, colback=dfbgtint,
+    arc=4pt, left=10pt, right=10pt, top=8pt, bottom=8pt,
     before skip=\baselineskip, after skip=0.5\baselineskip},
-  dftip/.style={enhanced, frame hidden,
-    borderline west={3.5pt}{0pt}{dfgreen}, colback=dfbggreen,
-    left=10pt, right=10pt, top=8pt, bottom=8pt,
+  dftip/.style={enhanced,
+    leftrule=3.5pt, rightrule=0pt, toprule=0pt, bottomrule=0pt,
+    colframe=dfgreen, colback=dfbggreen,
+    arc=4pt, left=10pt, right=10pt, top=8pt, bottom=8pt,
     before skip=\baselineskip, after skip=0.5\baselineskip},
-  dferrstyle/.style={enhanced, frame hidden,
-    borderline west={3.5pt}{0pt}{dferror}, colback=dfbgerror,
-    left=10pt, right=10pt, top=8pt, bottom=8pt,
+  dferrstyle/.style={enhanced,
+    leftrule=3.5pt, rightrule=0pt, toprule=0pt, bottomrule=0pt,
+    colframe=dferror, colback=dfbgerror,
+    arc=4pt, left=10pt, right=10pt, top=8pt, bottom=8pt,
     before skip=\baselineskip, after skip=0.5\baselineskip},
 }
 % Per-type opener commands
 \newcommand{\dfadmonnote}[1]{\begin{tcolorbox}[dfnote]{\color{dfaccent}\sffamily\bfseries#1}\par\smallskip}
 \newcommand{\dfadmonimportant}[1]{\begin{tcolorbox}[dfnote]{\color{dfaccent}\sffamily\bfseries#1}\par\smallskip}
+\newcommand{\dfadmonseealso}[1]{\begin{tcolorbox}[dfnote]{\color{dfaccent}\sffamily\bfseries#1}\par\smallskip}
 \newcommand{\dfadmontip}[1]{\begin{tcolorbox}[dftip]{\color{dfgreen}\sffamily\bfseries#1}\par\smallskip}
 \newcommand{\dfadmonhint}[1]{\begin{tcolorbox}[dftip]{\color{dfgreen}\sffamily\bfseries#1}\par\smallskip}
 \newcommand{\dfadmonwarning}[1]{\begin{tcolorbox}[dfwarn]{\color{dfprimary}\sffamily\bfseries#1}\par\smallskip}
@@ -128,9 +133,15 @@
   \ifcsdef{dfadmon#1}{\csuse{dfadmon#1}{#2}}{\dfadmonnote{#2}}%
 }
 % sphinx.sty is loaded by \documentclass before the user preamble runs, so
-% sphinxadmonition is already defined here and \renewenvironment works directly.
+% sphinxadmonition and sphinxseealso are already defined here and
+% \renewenvironment works directly.
 \renewenvironment{sphinxadmonition}[2]{%
   \dfadmonbegin{#1}{#2}%
 }{%
   \end{tcolorbox}%
 }
+\renewenvironment{sphinxseealso}[1]{%
+  \dfadmonseealso{#1}%
+}{%
+  \end{tcolorbox}%
+}