Skip to content
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

Fix pkgdown reference index #46

Closed
maelle opened this issue Jul 20, 2022 · 7 comments
Closed

Fix pkgdown reference index #46

maelle opened this issue Jul 20, 2022 · 7 comments
Labels
documentation Improvements or additions to documentation

Comments

@maelle
Copy link
Member

maelle commented Jul 20, 2022

👋 @agricolamz!

The pkgdown build for your package is currently failing because some of the documentation topics are missing from the pkgdown config file. Could you please fix?

> pkgdown::check_pkgdown()
Error in `check_missing_topics()`:
! All topics must be included in reference indexMissing topics: add_leading_symbols, create_image_look_up, create_sound_play, create_viewer, df_to_eaf, df_to_exb, remove_textgrid_tier
@maelle maelle added the documentation Improvements or additions to documentation label Jul 20, 2022
@maelle
Copy link
Member Author

maelle commented Jul 20, 2022

Note that for topics you do not want to include in the index you can create an "internal" section https://pkgdown.r-lib.org/reference/build_reference.html?q=internal#missing-topics

@maelle
Copy link
Member Author

maelle commented Jul 20, 2022

To check all topics are listed, after editing the configuration file you can run pkgdown::check_pkgdown().

@maelle
Copy link
Member Author

maelle commented Aug 23, 2022

wave @agricolamz! Friendly reminder 😸

@agricolamz
Copy link
Collaborator

Dear @maelle, I've seen the problem, but I will be able to react only in mid September. Sorry...

@maelle
Copy link
Member Author

maelle commented Sep 20, 2022

👋 @agricolamz! Friendly reminder 😄

agricolamz added a commit that referenced this issue Sep 23, 2022
@agricolamz
Copy link
Collaborator

@maelle, thank you, I guess now it is fine!

@maelle
Copy link
Member Author

maelle commented Sep 23, 2022

Yes, thank you!

@maelle maelle closed this as completed Sep 23, 2022
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
None yet
Development

No branches or pull requests

2 participants