From dee7e098beff8e3e16bc39203820e6a842a09320 Mon Sep 17 00:00:00 2001 From: Julien Barnier Date: Mon, 8 Apr 2024 16:35:37 +0200 Subject: [PATCH] doc: improve presentation and quartodoc config --- doc/_quarto.yml | 35 +++++++++++++++++++++++++++++------ doc/custom.scss | 11 ++++++++++- 2 files changed, 39 insertions(+), 7 deletions(-) diff --git a/doc/_quarto.yml b/doc/_quarto.yml index c942ab2..01666b9 100644 --- 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 index 29e84be..098d0ee 100644 --- 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 {