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

unlisted option to generate doc pages that don't get put on index #332

Open
machow opened this issue Jan 25, 2024 · 0 comments
Open

unlisted option to generate doc pages that don't get put on index #332

machow opened this issue Jan 25, 2024 · 0 comments
Labels

Comments

@machow
Copy link
Owner

machow commented Jan 25, 2024

From pairing with @schloerke, an unlisted option would benefit sites that want to document a lot of type annotations. For example, py-shiny wants users to be able to click through type annotations, but doesn't want to list them on the reference page. This is because there are a lot of them, and they live in various places. In a sense it's fairly low priority in the reference API, but useful supplementary info.

We could add a unlisted field to the quartodoc config, that renders the Auto pages, but does not create entries on the index page.

@machow machow added the shiny label Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Development

No branches or pull requests

1 participant