search

etiennebacher / altdoc

Alternative to pkgdown to document R packages
https://altdoc.etiennebacher.com
Other
62 stars 9 forks source link

Switch to R Markdown for man pages? #242

Open etiennebacher opened 8 months ago

etiennebacher commented 8 months ago

Rendering dozens of qmd files takes a lot of time because altdoc calls one quarto process per document, which takes 2-5 seconds. This mostly is a problem in polars where the update in altdoc increased the docs CI from ~4 min to ~12 min, even with parallel rendering.

It makes sense to use quarto for vignettes because users might mix qmd and Rmd files, but for man pages I wonder if using R Markdown wouldn't be sufficient. IIRC the only case when we need to use quarto for man pages is when the user builds a quarto website. If we know that the tool used is not "quarto_website" then we can switch to R Markdown.

etiennebacher commented 8 months ago

For now I'm mostly focused on having something robust and that works, though

vincentarelbundock commented 8 months ago

I don't know what code change this would involve. If you want to add an option, I guess that's fine, but removing quarto rendering would be a disappointing change.

Also, isn't that what freeze is for? Rendering polars should take no more than a minute with freeze. Build it once a month from scratch, and with freeze on a daily basis.