Tweak docs, in particular the styles

ichard26 · Jul 27, 2021 · e40f3b5 · e40f3b5
1 parent 35b0956
commit e40f3b5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,3 +58,5 @@
 html_theme = "furo"
 html_title = f"Blackbench {release}"
 html_favicon = "static/ichard26-favicon.png"
+html_static_path = ["static"]
+html_css_files = ["custom.css"]
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -146,9 +146,8 @@ less values.
 
 See the rest of the User Guide for an indepth explanation and guide to using blackbench
 effectively, to learn blackbench's more advanced features, and overall get better at
-benchmarking effectively. You can also take a look at the
-[pyperf documentation][pyperf-docs] since blackbench heavily depends on it for many
-parts of its functionality.
+benchmarking. You can also take a look at the [pyperf documentation][pyperf-docs] since
+blackbench heavily depends on it for many parts of its functionality.
 
 Thank you for using blackbench and I hope you make good use out of it!
 

diff --git a/docs/static/custom.css b/docs/static/custom.css
@@ -0,0 +1,19 @@
+/* Sadly the default pygments theme has very bad contrast of only 3.34,
+ * let's fix this. */
+.highlight .go {
+   color: #545454;
+}
+
+/* Tweak inline code blocks to be a bit more visually distinct and
+ * noticable. */
+code.literal {
+   border: 1px solid #f4f4f4;
+   margin-left: 0.2em;
+   margin-right: 0.2em;
+}
+
+@media (prefers-color-scheme: dark) {
+   code.literal {
+      border: 1px solid #151515;
+   }
+}