Skip to content

refactor: ♻️ delete whole references folder pre and post render #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

refactor: ♻️ delete whole references folder pre and post render #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9eec1b
build: :wrench: delete whole references folder pre and post render
martonvago Aug 13, 2025
f269d70
Merge branch 'main' into build/delete-ref-folder
martonvago Aug 18, 2025
dae1e9a
Merge branch 'main' into build/delete-ref-folder
lwjohnst86 Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions template/_quarto.yml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
project:
type: website
# Delete auto-generated files from `quartodoc`
post-render: rm -f docs/reference/*.qmd
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wasn't deleting the files for me for some reason.
There are also other files in the folder -- I'm assuming all can be deleted as we're not tracking this folder?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested that quarto doesn't seem to use rm. So we could move the deletion outside of quarto 😌

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait so the new version doesn't work for you either?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New version? Of Quarto? Or using -rf? Both? Then yes maybe? 😆

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using post-render: rm -rf docs/reference.
For me post-render: rm -f docs/reference/*.qmd wasn't deleting the files.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This setting here can just be deleted, since the justfile contains the command to do it before hand.

# Delete files auto-generated by `quartodoc`
post-render: rm -rf docs/reference
render:
- "docs/*"
- "index.qmd"
Expand Down
2 changes: 1 addition & 1 deletion template/justfile.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ build-website:
export QUARTO_PYTHON=.venv/bin/python3
# Delete any previously built files from quartodoc.
# -f is to not give an error if the files don't exist yet.
rm -f docs/reference/*.qmd
rm -rf docs/reference
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this would cause problems. We initially used this in Sprout, but the problem is that there is a file in that folder that is needed and deleting it before building seemed to cause some problems. What was the reason you wanted to switch this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make it match the other change. But yeah, if we need the other files in the folder, then we shouldn't delete the folder haha.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this change is fine, since the issue was that quartodoc build was creating a file that Quarto needed. Since the deletion happens before quartodoc, this should work as intended.

uv run quartodoc build
uv run quarto render --execute

Expand Down
Loading