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

Document metadata like :orphan: is rendered as text if the ReST file is included. #3167

Closed
Paebbels opened this issue Nov 21, 2016 · 1 comment

Comments

@Paebbels
Copy link

I have a include file called Authors.rst, which is included into another document. The file is not referenced by a toctree directive. To suppress the "not referenced" warning, I added the metadata :orphan: to the Authors.rst file. Unfortunately, the text orphan: is displayed in the HTML output. (Not there is no leading colon in the text.)

Authors.rst:

:orphan:

.. # This file is included. So it needs to be marked as orphan to suppress warnings.

Some content

index.rst:

List of Contributers
********************

.. include:: ./Authors.rst

Rendered HTML output:
image


Related issues: #3149

@tk0miya
Copy link
Member

tk0miya commented Nov 22, 2016

You should not mark :orphan: for included files.
At current release, Sphinx does not warn for included files as orphaned.
So please remove them and upgrade your sphinx (if still warned).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants