doc: improve presentation and quartodoc config

Lifemap-ToL · Apr 8, 2024 · dee7e09 · dee7e09
1 parent e7a5d78
commit dee7e09
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 7 deletions.
diff --git a/doc/_quarto.yml b/doc/_quarto.yml
@@ -36,18 +36,41 @@ metadata-files:
     - _quartodoc_sidebar.yml
 
 quartodoc:
+    title: Reference
     style: pkgdown
     package: pylifemap
     sidebar: _quartodoc_sidebar.yml
-    title: Reference
     parser: numpy
     render_interlinks: true
+    renderer:
+        style: markdown
+        display_name: name
+    options:
+        include_functions: true
+        children: linked
     sections:
-        - title: Lifemap class
-          desc: Main Lifemap class.
+        - title: Visualization
+          desc: ""
           contents:
-              - Lifemap
-        - title: Aggregation functions
+              - name: Lifemap
+                members:
+                    [
+                        "layer_points",
+                        "layer_lines",
+                        "layer_donuts",
+                        "layer_heatmap",
+                        "layer_screengrid",
+                        "show",
+                        "save",
+                    ]
+              - Lifemap.layer_points
+              - Lifemap.layer_lines
+              - Lifemap.layer_donuts
+              - Lifemap.layer_heatmap
+              - Lifemap.layer_screengrid
+              - Lifemap.show
+              - Lifemap.save
+        - title: Data aggregation
           desc: Functions to aggregate data along the branches of the lifemap tree.
           contents:
               - aggregate_count
@@ -65,7 +88,7 @@ interlinks:
 format:
     html:
         theme:
-            - cosmo
+            - flatly
             - custom.scss
         mainfont: "Source Sans 3, Source Sans Pro, Segoe UI, Roboto, Helvetica, sans-serif"
         monofont: "SFMono-Regular, Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace"

diff --git a/doc/custom.scss b/doc/custom.scss
@@ -2,6 +2,7 @@
 
 $toc-color: #337AB7;
 $toc-active-border: #337AB7;
+$code-color: #C7254E;
 
 /*-- scss:rules --*/
 
@@ -24,10 +25,12 @@ $toc-active-border: #337AB7;
 /* General styles */
 
 a:hover {
-    color: #FF4222;
+    color: #67a9df;
     text-decoration: none;
 }
 
+/* Headings */
+
 .quarto-title {
     margin: 1.5em 0 1em 0;
 }
@@ -37,6 +40,12 @@ h1.doc {
     font-size: 2.5rem;
 }
 
+h2 {
+    margin-top: 3rem;
+    margin-bottom: 1.5rem;
+    border-bottom: none;
+}
+
 /* Source code */
 
 div.sourceCode {