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

More control on missing topic errors/warnings #1716

Closed
gaborcsardi opened this issue Jun 3, 2021 · 5 comments · Fixed by #1783
Closed

More control on missing topic errors/warnings #1716

gaborcsardi opened this issue Jun 3, 2021 · 5 comments · Fixed by #1783
Labels
feature a feature request or enhancement reference 📚

Comments

@gaborcsardi
Copy link
Member

I like to have some topics in articles, and also in the manual. In the proper manual, not as vignettes, as vignettes are less accessible, especially from the console. @keywords internal is also not great, because I do want them in the index.

So I propose we have an entry in the config file, where you can just list topics that are ignored on purpose.

@gaborcsardi gaborcsardi added the feature a feature request or enhancement label Jun 3, 2021
@StevenMMortimer
Copy link

StevenMMortimer commented Jul 7, 2021

Historically, @keywords internal has been the only suggested solution for this problem (see #1132 and #1378). Would love to see that change. Even an argument in build_site() might be sufficient without the overhead of maintaining a config file.

@hadley
Copy link
Member

hadley commented Sep 21, 2021

Maybe we could just have a special section name that's not displayed on the reference page.

@gaborcsardi
Copy link
Member Author

Yeah, that would work great, I think.

@hadley
Copy link
Member

hadley commented Sep 23, 2021

Two options:

  • Drop any section with title "Internal" (like keywords)
  • Drop any section with title starting with _ (like vignettes)

Any preference?

@gaborcsardi
Copy link
Member Author

Very slightly prefer the first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement reference 📚
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants