Skip to content

Return empty toctree for missing TOC #264

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.

Sign up for GitHub

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

Open
Herrtian wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Return empty toctree for missing TOC #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions notfound/extension.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,9 @@ def toctree(*args, **kwargs):
**kwargs,
)

# If no TOC is found, just return ``None`` instead of failing here
# Match Sphinx's toctree helper return type when no TOC is found.
if not toc:
return None
return ''

replace_uris(app, toc, docutils.nodes.reference, 'refuri')
return app.builder.render_partial(toc)['fragment']
Expand Down
6 changes: 6 additions & 0 deletions tests/examples/empty-toctree/_templates/toctree.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<!doctype html>
<html>
<body>
<div id="toctree-result">{{ toctree() }}</div>
</body>
</html>
10 changes: 10 additions & 0 deletions tests/examples/empty-toctree/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# conf.py to run tests

project = 'Python'
master_doc = 'index'
extensions = [
'notfound.extension',
]

templates_path = ['_templates']
notfound_template = 'toctree.html'
4 changes: 4 additions & 0 deletions tests/examples/empty-toctree/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Single page
===========

This page does not define a toctree.
14 changes: 13 additions & 1 deletion tests/test_urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@

extensiondir = Path(__file__).resolve().parent / 'examples' / 'extension'

emptytoctreedir = Path(__file__).resolve().parent / 'examples' / 'empty-toctree'

@pytest.fixture(autouse=True, scope='function')
def remove_sphinx_build_output():
"""Remove _build/ folder, if exist."""
for path in (srcdir, rstsrcdir, extensiondir):
for path in (srcdir, rstsrcdir, extensiondir, emptytoctreedir):
build_path = path / '_build'
if build_path.exists():
shutil.rmtree(build_path)
Expand Down Expand Up @@ -475,6 +477,16 @@ def test_toctree_links_custom_settings(app, status, warning):
assert chunk in content


@pytest.mark.sphinx(srcdir=emptytoctreedir)
def test_empty_toctree_returns_empty_string(app, status, warning):
app.build()
path = app.outdir / '404.html'
assert path.exists()

content = path.read_text()
assert '<div id="toctree-result"></div>' in content


@pytest.mark.sphinx(
srcdir=rstsrcdir,
)
Expand Down