Skip to content

Commit 6e271d2

Browse files
feat: ✨ justfile recipe to preview docs (#173)
# Description Copying over from seedcase-project/seedcase-sprout#1593, see rationale there This PR needs a quick review. ## Checklist - [ ] Formatted Markdown - [ ] Ran `just run-all` --------- Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
1 parent 9035530 commit 6e271d2

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

template/justfile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,20 @@ update-from-template:
5858
# Reset repo changes to match the template
5959
reset-from-template:
6060
uvx copier recopy --trust --defaults
61+
62+
# Build the Python docstrings as a section in the website using quartodoc
63+
build-quartodoc:
64+
# To let Quarto know where python is.
65+
export QUARTO_PYTHON=.venv/bin/python3
66+
# Delete any previously built files from quartodoc.
67+
# -f is to not give an error if the files don't exist yet.
68+
rm -rf docs/reference
69+
uv run quartodoc build
70+
71+
# Build the documentation website using Quarto
72+
build-website: build-quartodoc
73+
uv run quarto render --execute
74+
75+
# Preview the documentation website with automatic reload on changes
76+
preview-website: build-quartodoc
77+
uv run quarto preview --execute

0 commit comments

Comments
 (0)