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 configuration for reference #75

Closed
maelle opened this issue Sep 2, 2022 · 1 comment
Closed

Fix pkgdown configuration for reference #75

maelle opened this issue Sep 2, 2022 · 1 comment

Comments

@maelle
Copy link
Member

maelle commented Sep 2, 2022

Some topics are missing from the configuration file.

 Error in check_missing_topics(rows, pkg) : 
  All topics must be included in reference indexMissing topics: CoordinateCleaner-package, buffland, buffsea, countryref, institutions, pbdb_example, plot.spatialvalid, write_pyrate

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

You can also use the @keywords internal tag and redocument for, say, the package manual page.

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

@maelle
Copy link
Member Author

maelle commented Sep 6, 2022

@azizka

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

No branches or pull requests

1 participant