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 users to parse and include documents in their MyST build that aren't part of the table of contents #1666

Open
agoose77 opened this issue Nov 21, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@agoose77
Copy link
Contributor

agoose77 commented Nov 21, 2024

It can be useful to have pages that define content (executable outputs, markdown snippets, etc) that are solely meant for re-use in a book, and aren't part of the book itself.

Right now, for a document's content to be available in a book (e.g. with {embed}) it must also be listed in the toc: and will show up in the sidebar.

Instead, there should be a way to get MyST to parse content even though it isn't meant for inclusion in the sidebar.

References

  • Sphinx uses orphan annotations in the frontmatter for this, so that files are parsed but not flagged for warnings because they aren't in the TOC
  • Original discussion thread
@agoose77 agoose77 added the enhancement New feature or request label Nov 21, 2024
@choldgraf choldgraf changed the title Support hiding of certain files from build output Allow users to parse and include documents in their MyST build that aren't part of the table of contents Nov 21, 2024
@choldgraf
Copy link
Collaborator

@agoose77 I cleaned up the issue body a bit so that it was clearer what kind of end-functionality we needed from a user's perspective

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

No branches or pull requests

2 participants