-
Notifications
You must be signed in to change notification settings - Fork 18
DOCS: move from sphinx to quartodoc #153
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.
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
Conversation
|
|
||
| quartodoc: | ||
| style: pkgdown | ||
| title: "Vetiver-{{< env VERSION >}}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For whatever reason, any spaces between vetiver and {{< env VERSION >}} in this title causes the version to not show up in the sidebar. If I write {{< env VERSION >}} vetiver it does show, or if I have a title with no blank spaces. This is not blocking, but want to note this behavior.
machow
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahhhh, incredible! I made a very small note that I think your update_environment.py script could run a lot during quarto preview. For some reason, I don't commit the interlinks extension (since I'm installing quartodoc in the CI anyway), but I know quarto suggests it 😅.
| @@ -0,0 +1,106 @@ | |||
| project: | |||
| type: website | |||
| pre-render: version_config.py | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this pre-render script will run every time a page updates, when using quarto preview (which could slow down preview times a bit?)
https://quarto.org/docs/projects/scripts.html#pre-and-post-render
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like that is the case! I think I'm going to leave it in the pre-render section for now to ensure it is always run (primarily to build the docs locally) since then you can use quarto preview, quarto render, or make docs and the version will be updated regardless. But this is still great to note if the docs site gets huge (or maybe when it gets merged with vetiver.rstudio.com), this is a way to speed up quarto preview if it feels sluggish.




my minimum requirements to swap from sphinx to quartodoc: