Skip to content

handling vignettes/articles subfolder and custom sidebars#355

Draft
d-morrison wants to merge 12 commits into
etiennebacher:mainfrom
d-morrison:recursive-qmd-search
Draft

handling vignettes/articles subfolder and custom sidebars#355
d-morrison wants to merge 12 commits into
etiennebacher:mainfrom
d-morrison:recursive-qmd-search

Conversation

@d-morrison
Copy link
Copy Markdown

I hope it's ok to send this PR; feel free to close if not!

I attempted fixes for two problems I ran into (reprex: https://github.com/UCD-SERG/rpt):

  1. find .qmd files in the vignettes/articles subfolder (https://r-pkgs.org/vignettes.html#sec-vignettes-article)

  2. include singleton entries in custom sidebars in preprocessed _quarto.yml

2b. Print the preprocessed _quarto.yml in verbose mode (helped diagnose 2)

Glad to revise as helpful, if this is of interest. Thanks for this awesome package!

@etiennebacher
Copy link
Copy Markdown
Owner

etiennebacher commented Jan 30, 2026

Hi @d-morrison, thanks for the PR! I'll take a closer look tomorrow but I already have a few comments:

  1. please add tests for this change. You'll see in tests/testthat/examples that there are several examples of testpkg, which are tiny skeletons of packages that have the feature to test (in this case, vignettes in subfolders and singleton entries). You can add an extra package there and then test it in test-render_docs.R.
    • running the entire test suite can take some time, so I suggest running devtools::test(filter = "render_docs")
  2. you should format the code with Air
  3. add an entry in NEWS.md
  4. I'm not convinced printing the settings should be done. Even if it were, let's not include it in this PR.

@d-morrison
Copy link
Copy Markdown
Author

Hi @d-morrison, thanks for the PR! I'll take a closer look tomorrow but I already have a few comments:

  1. please add tests for this change. You'll see in tests/testthat/examples that there are several examples of testpkg, which are tiny skeletons of packages that have the feature to test (in this case, vignettes in subfolders and singleton entries). You can add an extra package there and then test it in test-render_docs.R.

    • running the entire test suite can take some time, so I suggest running devtools::test(filter = "render_docs")
  2. you should format the code with Air

  3. add an entry in NEWS.md

  4. I'm not convinced printing the settings should be done. Even if it were, let's not include it in this PR.

@etiennebacher thanks, will do!

@d-morrison d-morrison marked this pull request as draft January 30, 2026 22:46
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.

2 participants