Skip to content

Commit 5b6349a

Browse files
authored
feat: ✨ add website preview build step (#255)
# Description I noticed this wasn't here when I updated another package via copier. We already have it in the data template package, but I think it should be here too? Needs a quick review. ## Checklist - [x] Ran `just run-all`
1 parent d207c9d commit 5b6349a

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

template/justfile.jinja

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,23 @@ format-python:
6767
format-md:
6868
uvx rumdl fmt --silent
6969

70-
# Build the documentation website using Quarto
71-
build-website:
70+
# Build the Python docstrings as a section in the website using quartodoc
71+
build-quartodoc:
7272
# To let Quarto know where python is.
7373
export QUARTO_PYTHON=.venv/bin/python3
7474
# Delete any previously built files from quartodoc.
7575
# -f is to not give an error if the files don't exist yet.
7676
rm -rf docs/reference
7777
uv run quartodoc build
78+
79+
# Build the documentation website using Quarto
80+
build-website: build-quartodoc
7881
uv run quarto render --execute
7982

83+
# Preview the documentation website with automatic reload on changes
84+
preview-website: build-quartodoc
85+
uv run quarto preview --execute
86+
8087
# Check the commit messages on the current branch that are not on the main branch
8188
check-commits:
8289
#!/usr/bin/env bash

0 commit comments

Comments
 (0)