Improve visually docs

Add css rules, add autodoc_type_aliases
quarkslab · Sep 13, 2023 · b0c34d7 · b0c34d7
1 parent 5b61b1c
commit b0c34d7
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/_static/style.css b/_static/style.css
@@ -4,4 +4,21 @@ div.sphinxsidebar p.caption {
     background: linear-gradient(90deg, rgba(232, 232, 237, 0) 0%, rgb(232, 232, 237) 17.6px, rgb(232, 232, 237) 100%);
     font-weight: bold;
     font-size: 15px;
+}
+
+.relbar,
+.relbar>a:hover .direction {
+    color: #7B7B7B;
+}
+
+.nav-icon:visited {
+    color: #E5E5E5;
+}
+
+#topbar button:hover,
+#titlebar .buttons> :hover,
+#titlebar a:hover,
+.relbar a:hover,
+.relbar a:hover .icon {
+    color: #2D2D2D;
 }
diff --git a/conf.py b/conf.py
@@ -95,6 +95,10 @@
     "quokka": ("https://quarkslab.github.io/quokka/", None),
 }
 
+autodoc_type_aliases = {
+    "ReferenceTarget": "Data | Structure | StructureMember"
+}
+
 autodoc_typehints_format = "short"
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/index.rst b/index.rst
@@ -35,7 +35,7 @@ Qbindiff
 
 .. toctree::
     :caption: Qbindiff
-    :maxdepth: 2
+    :maxdepth: 3
 
     qbindiff/doc/source/intro
     qbindiff/doc/source/install