From 5a407902de0ca746bca76c7e2099ee5ba9d4d8d3 Mon Sep 17 00:00:00 2001 From: Michael Chow Date: Mon, 4 Nov 2024 15:47:47 -0500 Subject: [PATCH 1/3] docs: fix sidebar preview and collapse --- docs/get-started/sidebar.qmd | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/get-started/sidebar.qmd b/docs/get-started/sidebar.qmd index 0e1af47..f162a2d 100644 --- a/docs/get-started/sidebar.qmd +++ b/docs/get-started/sidebar.qmd @@ -23,12 +23,16 @@ with a [Quarto sidebar configuration](https://quarto.org/docs/websites/website-n The Quarto [`metadata-files` option](https://quarto.org/docs/projects/quarto-projects.html#metadata-includes) ensures it's included with the configuration in `_quarto.yml`. +::: { .callout-note} Here is what the sidebar for the [quartodoc reference page](/api) looks like: -
-
{{< include /api/_sidebar.yml >}}
-
-
+
+```yaml +{{< include /api/_sidebar.yml >}} +``` +
+ +::: ## Customizing the sidebar From 6b7ce1935033e536a2692825a0002a54210e5ea5 Mon Sep 17 00:00:00 2001 From: Michael Chow Date: Fri, 8 Nov 2024 15:12:47 -0500 Subject: [PATCH 2/3] dev: quartodoc build in Makefile now verbose --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 2af9bef..90d169e 100644 --- a/Makefile +++ b/Makefile @@ -46,7 +46,7 @@ docs-build-readme: docs-build: export PLUM_SIMPLE_DOC=1 docs-build: docs-build-examples cd docs && quarto add --no-prompt .. - cd docs && quartodoc build + cd docs && quartodoc build --verbose cd docs && quartodoc interlinks quarto render docs From d7c3756ac240cb12fe6fce46f0570655b1e64a02 Mon Sep 17 00:00:00 2001 From: Michael Chow Date: Fri, 8 Nov 2024 15:17:04 -0500 Subject: [PATCH 3/3] dev: switch order of building API and adding extensions --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 90d169e..4a79372 100644 --- a/Makefile +++ b/Makefile @@ -45,9 +45,9 @@ docs-build-readme: docs-build: export PLUM_SIMPLE_DOC=1 docs-build: docs-build-examples - cd docs && quarto add --no-prompt .. cd docs && quartodoc build --verbose cd docs && quartodoc interlinks + cd docs && quarto add --no-prompt .. quarto render docs test-interlinks: quartodoc/tests/example_interlinks/test.md