Merge pull request #3518 from agjohnson/fix-singlehtml-empty-toctree

Allow empty toctree in singlehtml builder
This commit is contained in:
Takeshi KOMIYA 2017-03-29 22:24:16 +09:00 committed by GitHub
commit d0384130cc
5 changed files with 23 additions and 1 deletions

View File

@ -968,7 +968,8 @@ class SingleFileHTMLBuilder(StandaloneHTMLBuilder):
if 'includehidden' not in kwds:
kwds['includehidden'] = False
toctree = self.env.get_toctree_for(docname, self, collapse, **kwds)
self.fix_refuris(toctree)
if toctree is not None:
self.fix_refuris(toctree)
return self.render_partial(toctree)['fragment']
def assemble_doctree(self):

View File

@ -0,0 +1,2 @@
{# This will call toctree unconditionally, whether there is a local or global toc #}
{{ toctree() }}

View File

@ -0,0 +1,6 @@
# -*- coding: utf-8 -*-
master_doc = 'index'
html_theme = 'classic'
exclude_patterns = ['_build']
templates_path = ['_templates']

View File

@ -0,0 +1,4 @@
test-toctree-empty
==================
.. toctree::

View File

@ -26,3 +26,12 @@ def test_relations(app, status, warning):
assert app.builder.relations['qux/qux_1'] == ['qux/index', 'qux/index', 'qux/qux_2']
assert app.builder.relations['qux/qux_2'] == ['qux/index', 'qux/qux_1', None]
assert 'quux' not in app.builder.relations
@pytest.mark.sphinx('singlehtml', testroot='toctree-empty')
def test_singlehtml_toctree(app, status, warning):
app.builder.build_all()
try:
app.builder._get_local_toctree('index')
except AttributeError:
pytest.fail('Unexpected AttributeError in app.builder.fix_refuris')