<https://lh3.googleusercontent.com/-_QIUNHJzVIA/V_59913blBI/AAAAAAAAABo/WMZZHkBmnk8EMTVu725h3uSnunf--ZxxACLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.16.39%2BPM.png>
Once again I should confess that I am running Sphinx v1.3.2, so if there have been bug fixes that address this, I need to upgrade. I am only using the :orphan: tag with files that are included in other files. It shows up in my HTML as orphan: and is formatted similar to a table header. <https://lh3.googleusercontent.com/-2wgksnJnBeI/V_58168wo3I/AAAAAAAAABc/cwx81ySfPT0yPDdL-9pcXrKsqFdr4TgBwCLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.04.48%2BPM.png>[image: frontmatter.rst source file] <https://lh3.googleusercontent.com/-2wgksnJnBeI/V_58168wo3I/AAAAAAAAABc/cwx81ySfPT0yPDdL-9pcXrKsqFdr4TgBwCLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.04.48%2BPM.png>[image: include statement] <https://lh3.googleusercontent.com/-_QIUNHJzVIA/V_59913blBI/AAAAAAAAABo/WMZZHkBmnk8EMTVu725h3uSnunf--ZxxACLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.16.39%2BPM.png> [image: html result] <https://lh3.googleusercontent.com/-XSHpskG5hwI/V_589lGqa3I/AAAAAAAAABg/t7DTOBb7DX0Qfxq1iXewowx5A5Yut056QCLcB/s1600/Screen%2BShot%2B2016-10-12%2Bat%2B2.05.30%2BPM.png> On Wednesday, October 12, 2016 at 1:20:29 PM UTC-4, Komiya Takeshi wrote: > > > Can you give an example of how to use the orphan metadata tag? >> > > Here: > > :orphan: > > Title of document > ================== > > blah blah blah... > > >> >> - Where do I put the tag, in the file that is causing the build >> warning or in the TOC file? >> >> The top of each files which are not listed in toctree. > > >> >> - What syntax is used - is "orphan" meant to be the field name or >> field content term? >> >> > "orphan" is a field name. orphan field does not need any content. so only > `:orphan:` works well. > > >> >> - Is there another tag that goes with this syntax to hide it from the >> output? >> >> When I tried adding :orphan: at the top of my file, I didn't see the >> build warning, but the word "orphan:" also appeared on my HTML page. >> > > That's strange. The orphan metadata is not appeared in HTML docs. > Could you share your example? > > Thanks, > Takeshi KOMIYA > > >> >> >>> If you want to prevent warnings, please mark the document as :orphan:. >>> To use it, please refere following page: >>> >>> http://www.sphinx-doc.org/en/stable/markup/misc.html?highlight=orphan#file-wide-metadata >>> >>> Thanks, >>> Takeshi KOMIYA >>> >>> -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
