Skip to content

Commit 0e78cf0

Browse files
build: 🔨 add doc preview action to build (#261)
# Description Same change as in the other repos a while ago. Needs a quick review. ## Checklist - [x] Ran `just run-all` Co-authored-by: Luke W. Johnston <lwjohnst86@users.noreply.github.com>
1 parent d8bc5bb commit 0e78cf0

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

justfile

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,23 @@ format-python:
6060
uv run ruff check --fix .
6161
uv run ruff format .
6262

63-
# Build the documentation website using Quarto
64-
build-website:
63+
# Build the Python docstrings as a section in the website using quartodoc
64+
build-quartodoc:
6565
# To let Quarto know where python is.
6666
export QUARTO_PYTHON=.venv/bin/python3
6767
# Delete any previously built files from quartodoc.
6868
# -f is to not give an error if the files don't exist yet.
6969
rm -rf docs/reference
7070
uv run quartodoc build
71+
72+
# Build the documentation website using Quarto
73+
build-website: build-quartodoc
7174
uv run quarto render --execute
7275

76+
# Preview the documentation website with automatic reload on changes
77+
preview-website: build-quartodoc
78+
uv run quarto preview --execute
79+
7380
# Check the commit messages on the current branch that are not on the main branch
7481
check-commits:
7582
#!/usr/bin/env bash

0 commit comments

Comments
 (0)