Skip to content

Conversation

@isabelizimm
Copy link
Contributor

@isabelizimm isabelizimm commented Feb 7, 2023

my minimum requirements to swap from sphinx to quartodoc:

  • build docs in quartodoc
  • update makefiles to use in CI
  • remove sphinx artifacts
  • add version swapping between latest/stable

@isabelizimm
Copy link
Contributor Author

isabelizimm commented Feb 15, 2023

Weird behavior of using env {{ VERSION }}

Screen Shot 2023-02-15 at 4 00 58 PM

✅ Fixed by moving version to reference page only, rather than site-wide

@isabelizimm
Copy link
Contributor Author

isabelizimm commented Feb 15, 2023

how links are handled

Screen Shot 2023-02-15 at 4 03 18 PM

@isabelizimm
Copy link
Contributor Author

isabelizimm commented Feb 21, 2023

Screen Shot 2023-02-15 at 4 10 17 PM

In current docs, there are not full names of types coming from the typing package, whereas in quartodoc there are.

❌ do not need to fix

@isabelizimm
Copy link
Contributor Author

isabelizimm commented Feb 21, 2023

Screen Shot 2023-02-15 at 4 02 44 PM

weird wrapping

❌ do not need to fix, only happens when browser window is quite narrow. will be fixed later in quartodoc

@isabelizimm isabelizimm marked this pull request as ready for review February 21, 2023 22:07
@isabelizimm isabelizimm requested a review from machow February 21, 2023 22:07
@isabelizimm isabelizimm added the documentation Improvements or additions to documentation label Feb 21, 2023

quartodoc:
style: pkgdown
title: "Vetiver-{{< env VERSION >}}"
Copy link
Contributor Author

@isabelizimm isabelizimm Feb 22, 2023

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.

Copy link
Contributor

@machow machow left a 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
Copy link
Contributor

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

Copy link
Contributor Author

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.

@isabelizimm isabelizimm merged commit fc0e53b into main Feb 28, 2023
@isabelizimm isabelizimm deleted the quartodoc branch February 28, 2023 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

2 participants