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

[docs] ensure pkgdown site index accurately reflects R-package public API (fixes #6444) #6445

Merged
merged 2 commits into from
May 6, 2024

Conversation

jameslamb
Copy link
Collaborator

@jameslamb jameslamb commented May 6, 2024

Fixes #6444.

Fixes LightGBM's documentation builds. These were failing because {pkgdown}, the tool used to generate the R docs site, now raises errors under the following conditions:

  • objects mentioned in its config don't exist in the library
  • site index is missing any objects exported by the library

How I tested this

Enabled readthedocs builds and saw them succeed:

@jameslamb jameslamb changed the title WIP: [docs] remove reference to slice() in pkgdown docs (fixes #6444) WIP: [docs] ensure pkgdown site index accurately reflects R-package public API (fixes #6444) May 6, 2024
@jameslamb jameslamb changed the title WIP: [docs] ensure pkgdown site index accurately reflects R-package public API (fixes #6444) [docs] ensure pkgdown site index accurately reflects R-package public API (fixes #6444) May 6, 2024
@jameslamb jameslamb marked this pull request as ready for review May 6, 2024 02:29
@jameslamb
Copy link
Collaborator Author

thanks @jmoralez !

@jameslamb jameslamb merged commit f539536 into master May 6, 2024
38 checks passed
@jameslamb jameslamb deleted the docs/pkgdown-docs branch May 6, 2024 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] readthedocs builds are broken
2 participants