mirror of
https://github.com/readthedocs/sphinx_rtd_theme.git
synced 2025-02-25 18:55:21 -06:00
76a933b997
The previous behavior was deemed a bug and fixed in https://github.com/sphinx-doc/sphinx/pull/11970 Closes #1558 Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
91 lines
3.2 KiB
Python
91 lines
3.2 KiB
Python
import os
|
|
|
|
import pytest
|
|
import sphinx
|
|
from sphinx import addnodes
|
|
try:
|
|
# Available from Sphinx 2.0
|
|
from sphinx.builders.dirhtml import DirectoryHTMLBuilder
|
|
from sphinx.builders.singlehtml import SingleFileHTMLBuilder
|
|
except ImportError:
|
|
from sphinx.builders.html import (
|
|
DirectoryHTMLBuilder,
|
|
SingleFileHTMLBuilder,
|
|
)
|
|
|
|
from .util import build_all
|
|
|
|
|
|
def test_basic():
|
|
for (app, status, warning) in build_all('test-basic'):
|
|
assert app.env.get_doctree('index').findall(addnodes.toctree)
|
|
content = open(os.path.join(app.outdir, 'index.html')).read()
|
|
|
|
if isinstance(app.builder, DirectoryHTMLBuilder):
|
|
search = (
|
|
'<div class="toctree-wrapper compound">\n'
|
|
'<ul>\n'
|
|
'<li class="toctree-l1">'
|
|
'<a class="reference internal" href="foo/">foo</a>'
|
|
'<ul>\n'
|
|
'<li class="toctree-l2">'
|
|
'<a class="reference internal" href="bar/">bar</a></li>\n'
|
|
'</ul>\n'
|
|
'</li>\n'
|
|
'</ul>\n'
|
|
'</div>'
|
|
)
|
|
assert search in content
|
|
elif isinstance(app.builder, SingleFileHTMLBuilder):
|
|
internal_ref = '#document-foo'
|
|
if sphinx.version_info[:3] < (7, 3, 0):
|
|
internal_ref = 'index.html' + internal_ref
|
|
search = (
|
|
'<ul>\n'
|
|
'<li class="toctree-l1">'
|
|
f'<a class="reference internal" href="{internal_ref}">foo</a>'
|
|
'</li>\n'
|
|
'</ul>'
|
|
)
|
|
assert search in content
|
|
else:
|
|
search = (
|
|
'<div class="toctree-wrapper compound">\n'
|
|
'<ul>\n'
|
|
'<li class="toctree-l1">'
|
|
'<a class="reference internal" href="foo.html">foo</a>'
|
|
'<ul>\n'
|
|
'<li class="toctree-l2">'
|
|
'<a class="reference internal" href="bar.html">bar</a></li>\n'
|
|
'</ul>\n'
|
|
'</li>\n'
|
|
'</ul>\n'
|
|
'</div>'
|
|
)
|
|
assert search in content, ('Missing search with builder {0}'
|
|
.format(app.builder.name))
|
|
|
|
|
|
def test_empty():
|
|
"""Local TOC is showing, as toctree was empty"""
|
|
for (app, status, warning) in build_all('test-empty'):
|
|
assert app.env.get_doctree('index').findall(addnodes.toctree)
|
|
content = open(os.path.join(app.outdir, 'index.html')).read()
|
|
global_toc = '<div class="toctree-wrapper compound">\n</div>'
|
|
local_toc = (
|
|
'<div class="local-toc"><ul>\n'
|
|
'<li><a class="reference internal" href="#">test-empty</a></li>'
|
|
'</ul>\n</div>'
|
|
)
|
|
assert global_toc in content
|
|
assert local_toc not in content
|
|
|
|
|
|
def test_missing_toctree():
|
|
"""Local TOC is showing, as toctree was missing"""
|
|
for (app, status, warning) in build_all('test-missing-toctree'):
|
|
assert list(app.env.get_doctree('index').findall(addnodes.toctree)) == []
|
|
content = open(os.path.join(app.outdir, 'index.html')).read()
|
|
assert '<div class="toctree' not in content
|
|
assert '<div class="local-toc">' in content
|