From 144786b60cfd1748767e8c6351fa9e20192a681a Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 31 Oct 2024 11:31:31 -0400 Subject: [PATCH 1/3] chore: :see_no_evil: ignore auto-generated quartodoc files --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 7bb42df..4ba75a4 100644 --- a/.gitignore +++ b/.gitignore @@ -68,8 +68,13 @@ cover/ /.quarto/ docs/.quarto/ *.ipynb +*.quarto_ipynb *.storage +# Quartodoc +/docs/reference/ +objects.json + # Website generation _site _book From 98f98b37f42cf6b612417dd34a544a3d6c37ca5f Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 31 Oct 2024 11:32:12 -0400 Subject: [PATCH 2/3] build: :hammer: add quatodoc command to justfile recipe --- justfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/justfile b/justfile index c026acf..bfac06a 100644 --- a/justfile +++ b/justfile @@ -55,9 +55,10 @@ reset-local: rm persistent_storage/raw/*.csv # Build the documentation website using Quarto -build-website: +build-website: install-deps # To let Quarto know where python is. export QUARTO_PYTHON=.venv/bin/python3 + poetry run quartodoc build poetry run quarto render --execute # Add files for a new function (function file and test file) From d5663e1b02e32b71aa3271a5d5efa26fcc1d67ff Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Thu, 31 Oct 2024 11:32:45 -0400 Subject: [PATCH 3/3] build: :hammer: add `run-all` recipe to justfile to simply checks --- justfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/justfile b/justfile index bfac06a..7bd49f3 100644 --- a/justfile +++ b/justfile @@ -1,6 +1,8 @@ @_default: just --list --unsorted +run-all: install-deps format-python check-python run-tests + # Generate SVG images from all PlantUML files generate-puml-all: docker run --rm -v $(pwd):/puml -w /puml ghcr.io/plantuml/plantuml:latest -tsvg "**/*.puml"