Skip to content

Commit 11e0872

Browse files
committed
Switch docs to sphinx-book-theme
The only reason is because MyST figure captions vanished and I have no time to investigate
1 parent b4edc34 commit 11e0872

File tree

5 files changed

+13
-25
lines changed

5 files changed

+13
-25
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Thanks to its flexible design, *you* choose whether you want *structlog* to take
3131

3232
The output format is just as flexible and *structlog* comes with support for JSON, [*logfmt*](https://brandur.org/logfmt), as well as pretty console output out-of-the-box:
3333

34-
[![image](https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true)](https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true)
34+
[![Screenshot of colorful structlog output with ConsoleRenderer](https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true)](https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true)
3535

3636

3737
## Sponsors

docs/_static/custom.css

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,8 @@
33

44

55
:root {
6-
font-feature-settings: 'liga' 1, 'calt' 1;
7-
/* fix for Chrome */
8-
}
9-
10-
@supports (font-variation-settings: normal) {
11-
:root {
12-
font-family: 'Atkinson Hyperlegible', sans-serif;
13-
}
14-
}
15-
16-
17-
/* Hide ToC caption text within the main body (but leave them in the side-bar). */
18-
#furo-main-content span.caption-text {
19-
display: none;
6+
font-feature-settings: 'liga' 1, 'calt' 1; /* fix for Chrome */
7+
--pst-font-family-base: "Atkinson Hyperlegible", system-ui, sans-serif;
8+
--pst-font-family-heading: "Atkinson Hyperlegible", system-ui, sans-serif;
9+
--pst-font-family-monospace: BerkeleyMono, ui-monospace, 'Cascadia Code', 'Source Code Pro', Menlo, Consolas, 'DejaVu Sans Mono', monospace;
2010
}

docs/conf.py

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"sphinx.ext.viewcode",
3333
"sphinxcontrib.mermaid",
3434
"sphinxext.opengraph",
35+
"sphinx_copybutton",
3536
]
3637

3738
myst_enable_extensions = [
@@ -99,15 +100,8 @@
99100

100101
# -- Options for HTML output --------------------------------------------------
101102

102-
html_theme = "furo"
103-
html_theme_options = {
104-
"top_of_page_buttons": [],
105-
"light_css_variables": {
106-
"font-stack": "Atkinson Hyperlegible, sans-serif",
107-
"font-stack--monospace": "BerkeleyMono, MonoLisa, ui-monospace, "
108-
"SFMono-Regular, Menlo, Consolas, Liberation Mono, monospace",
109-
},
110-
}
103+
html_theme = "sphinx_book_theme"
104+
html_theme_options = {}
111105
html_logo = "_static/structlog_logo.svg"
112106
html_static_path = ["_static"]
113107
html_css_files = ["custom.css"]

docs/console-output.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Rich takes precedence over *better-exceptions*, but you can configure it by pass
1212
The following output is rendered using Rich:
1313

1414
```{figure} _static/console_renderer.png
15+
:alt: Screenshot of colorful console output by ConsoleRenderer.
16+
1517
Colorful console output by ConsoleRenderer.
1618
```
1719

pyproject.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,11 @@ tests = [
5252
typing = ["mypy>=1.4", "rich", "twisted"]
5353
docs = [
5454
"cogapp",
55-
"furo",
5655
"myst-parser",
5756
"sphinx",
57+
"sphinx-design",
58+
"sphinx-copybutton",
59+
"sphinx-book-theme",
5860
"sphinx-notfound-page",
5961
"sphinxcontrib-mermaid",
6062
"sphinxext-opengraph",

0 commit comments

Comments
 (0)