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

Handle :orphan: tags #88

Open
nikophil opened this issue Jan 4, 2019 · 2 comments
Open

Handle :orphan: tags #88

nikophil opened this issue Jan 4, 2019 · 2 comments
Assignees

Comments

@nikophil
Copy link
Contributor

nikophil commented Jan 4, 2019

I think :orphan: tag is not handle by the parser
https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata

After the build process is complete, we're performing some checks to see if every rst file has its equivalent html file. If some file marked as :orphan: doesn't have a matching html file, then we don't need to send a warning.

I don't really know if this check process should be in the core parser or in our side, but if we say it's in our land, that would be nice to have this information in meta...

what do you think ?

@jwage
Copy link
Member

jwage commented Jan 4, 2019

Should be fine to implement in core.

@linawolf
Copy link
Collaborator

Actually :orphan: fieles are still rendered in Sphinx. They just don't cause an error when they are not included in the toctree

@linawolf linawolf self-assigned this Feb 26, 2023
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

No branches or pull requests

3 participants