Make docs look OK with new theme (#115)

dev-cafe · Jul 18, 2022 · d59e689 · d59e689
1 parent 8b00da1
commit d59e689
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,13 +58,14 @@
 language = "en"
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 pygments_style = "sphinx"
+# Furo-specific option
+pygments_dark_style = "monokai"
 todo_include_todos = False
 
 # -- Options for HTML output -------------------------------------------
-html_title = "parselglossy Documentation"
+html_title = "parselglossy"
 html_short_title = f"parselglossy {version}"
 html_show_sourcelink = False
-html_sidebars = {"**": ["globaltoc.html", "localtoc.html"]}
 html_theme = "furo"
 html_theme_options = {
     "source_repository": "https://github.com/dev-cafe/parselglossy/",

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,8 @@
 .. title:: parselglossy
 
-==========================
-parselglossy Documentation
-==========================
+============
+parselglossy
+============
 
 .. epigraph::
 

diff --git a/parselglossy/types.py b/parselglossy/types.py
@@ -67,17 +67,17 @@ def type_matches(value: AllowedTypes, expected_type: str) -> Optional[bool]:
     Raises
     ------
     ValueError
-      If expected_type is not among the allowed types.
+      If `expected_type` is not among the allowed types.
 
     Notes
     -----
     Complex numbers are a tad more fastidious, as they *might be* read in as
     strings. To avoid false negatives, we have a nasty hack, for which RDR will
-    forever burn in hell. For complex and List[complex] we will re-run type
+    forever burn in hell. For `complex` and `List[complex]` we will re-run type
     checking after type casting if and only if:
 
-    - We expected complex and List[complex].
-    - We got a str or List[str].
+    - We expected `complex` and `List[complex]`.
+    - We got a `str` or `List[str]`.
     - The string are in the right format for the type casting operator.
     """