From 50fadb9e94078e38fa9b3d2974171cd6397bc31a Mon Sep 17 00:00:00 2001 From: Roland Meister Date: Mon, 10 Dec 2012 21:54:11 +0100 Subject: [PATCH] Bug #1047: templating toctree()'s includehidden argument Document the includehidden option and give it sane defaults. See bug #1047 for implementation alternatives. --- doc/templating.rst | 3 +++ sphinx/builders/html.py | 2 ++ 2 files changed, 5 insertions(+) diff --git a/doc/templating.rst b/doc/templating.rst index 05a1346c0..b9dfc683b 100644 --- a/doc/templating.rst +++ b/doc/templating.rst @@ -391,3 +391,6 @@ are in HTML form), these variables are also available: * ``titles_only`` (false by default): if true, put only toplevel document titles in the tree + + * ``includehidden`` (false by default): if true, the TOC tree will also + contain hidden entries. diff --git a/sphinx/builders/html.py b/sphinx/builders/html.py index f5218673f..7fa42057f 100644 --- a/sphinx/builders/html.py +++ b/sphinx/builders/html.py @@ -653,6 +653,8 @@ class StandaloneHTMLBuilder(Builder): self.indexer.feed(pagename, title, doctree) def _get_local_toctree(self, docname, collapse=True, **kwds): + if 'includehidden' not in kwds: + kwds['includehidden'] = False return self.render_partial(self.env.get_toctree_for( docname, self, collapse, **kwds))['fragment']