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

Allow to control abort on missing topics. #2025

Closed
wants to merge 1 commit into from
Closed

Conversation

jeroen
Copy link
Member

@jeroen jeroen commented Jan 21, 2022

This does not change any default behavior, but allows us to enable this locally, or disable it on CI, if needed.

@@ -1,5 +1,8 @@
# pkgdown (development version)

* Environment variable ABORT_ON_MISSING_TOPICS can be used to enable/disable
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you suggest a slightly more generic name? I think we'll also want to apply this to articles (#2055). And maybe it should have a PKGDOWN_ prefix?

@hadley hadley added this to the v2.0.4 milestone Jun 8, 2022
@jeroen
Copy link
Member Author

jeroen commented Jun 8, 2022

@maelle do you remember why we this was causing ropensci docs to fail? Was there another bug somewhere that caused the missing topics? Or should we just manually fix packages with invalid pkgdown.yml configs?

@maelle
Copy link
Collaborator

maelle commented Jun 9, 2022

should we just manually fix packages with invalid pkgdown.yml configs?

That might be smarter indeed

@hadley
Copy link
Member

hadley commented Jun 9, 2022

In that case, lets close this issue. I'm planning on making two other changes:

  • Make bad _pkgdown.yml abort locally, instead of warning, since you should be fixing these problems where ever you encounter them.
  • Create a lighter weight function that just checks for problems, without building the whole site.

@hadley hadley closed this Jun 9, 2022
@jeroen jeroen deleted the check_missing_topics branch June 9, 2022 13:13
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