Skip to content

Conversation

@LiNk-NY
Copy link
Contributor

@LiNk-NY LiNk-NY commented Aug 18, 2025

@federicomarini

Feel free to take a look and test

@federicomarini
Copy link

First rounds of test, here comes some results, for the records.

  • As anticipated, one would need the
vignette: >
  %\VignetteIndexEntry{title of vignette}
  %\VignetteEngine{BiocStyle::html}

and VignetteBuilder: BiocStyle in the DESCRIPTION

  • RStudio is not really able to pick up on the custom engine (in this case, BiocStyle::html) and renders the qmd document in a fairly vanilla manner, which makes it a bit chaotic to understand how the vignette really would look like if realized with our engine

  • this is circumvented with the classical R CMD BUILD . and opening the rendered qmd vignette one should find in the inst/doc folder

  • we might not be there yet with the styling as this is still squished in its width, see screenshot below

image

Still: I think this is a very good step in understanding how we can simplify the creation of Bioc-flavoured quarto docs, in the simplest way for many developers.
Happy to follow up once new developments come in 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants