IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9053 from tk0miya/title_node_for_toctree_caption

Browse Source 
Fix #8870: Use title node for the caption of toctree
This commit is contained in:
Takeshi KOMIYA 2021-04-09 01:35:46 +09:00 committed by GitHub
commit ce5d66e618
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -152,6 +152,8 @@ Features added
Bugs fixed Bugs fixed
---------- ----------
* #8870: The style of toctree captions has been changed with docutils-0.17
Testing Testing
-------- --------

2
sphinx/environment/adapters/toctree.py
View File

@ -236,7 +236,7 @@ class TocTree:
newnode = addnodes.compact_paragraph('', '') newnode = addnodes.compact_paragraph('', '')
caption = toctree.attributes.get('caption') caption = toctree.attributes.get('caption')
if caption: if caption:
caption_node = nodes.caption(caption, '', *[nodes.Text(caption)]) caption_node = nodes.title(caption, '', *[nodes.Text(caption)])
caption_node.line = toctree.line caption_node.line = toctree.line
caption_node.source = toctree.source caption_node.source = toctree.source
caption_node.rawsource = toctree['rawcaption'] caption_node.rawsource = toctree['rawcaption']

7
sphinx/writers/html.py
View File

@ -396,7 +396,12 @@ class HTMLTranslator(SphinxTranslator, BaseTranslator):
# overwritten # overwritten
def visit_title(self, node: Element) -> None: def visit_title(self, node: Element) -> None:
super().visit_title(node) if isinstance(node.parent, addnodes.compact_paragraph) and node.parent.get('toctree'):
self.body.append(self.starttag(node, 'p', '', CLASS='caption'))
self.body.append('<span class="caption-text">')
self.context.append('</span></p>\n')
else:
super().visit_title(node)
self.add_secnumber(node) self.add_secnumber(node)
self.add_fignumber(node.parent) self.add_fignumber(node.parent)
if isinstance(node.parent, nodes.table): if isinstance(node.parent, nodes.table):

7
sphinx/writers/html5.py
View File

@ -347,7 +347,12 @@ class HTML5Translator(SphinxTranslator, BaseTranslator):
# overwritten # overwritten
def visit_title(self, node: Element) -> None: def visit_title(self, node: Element) -> None:
super().visit_title(node) if isinstance(node.parent, addnodes.compact_paragraph) and node.parent.get('toctree'):
self.body.append(self.starttag(node, 'p', '', CLASS='caption'))
self.body.append('<span class="caption-text">')
self.context.append('</span></p>\n')
else:
super().visit_title(node)
self.add_secnumber(node) self.add_secnumber(node)
self.add_fignumber(node.parent) self.add_fignumber(node.parent)
if isinstance(node.parent, nodes.table): if isinstance(node.parent, nodes.table):

10
tests/test_environment_toctree.py
View File

@ -10,7 +10,7 @@
import pytest import pytest
from docutils import nodes from docutils import nodes
from docutils.nodes import bullet_list, caption, comment, list_item, reference from docutils.nodes import bullet_list, comment, list_item, reference, title
from sphinx import addnodes from sphinx import addnodes
from sphinx.addnodes import compact_paragraph, only from sphinx.addnodes import compact_paragraph, only
@ -211,7 +211,7 @@ def test_get_toctree_for(app):
app.build() app.build()
toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=False) toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=False)
assert_node(toctree, assert_node(toctree,
[compact_paragraph, ([caption, "Table of Contents"], [compact_paragraph, ([title, "Table of Contents"],
bullet_list, bullet_list,
bullet_list, bullet_list,
bullet_list)]) bullet_list)])
@ -251,7 +251,7 @@ def test_get_toctree_for_collapse(app):
app.build() app.build()
toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=True) toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=True)
assert_node(toctree, assert_node(toctree,
[compact_paragraph, ([caption, "Table of Contents"], [compact_paragraph, ([title, "Table of Contents"],
bullet_list, bullet_list,
bullet_list, bullet_list,
bullet_list)]) bullet_list)])
@ -283,7 +283,7 @@ def test_get_toctree_for_maxdepth(app):
toctree = TocTree(app.env).get_toctree_for('index', app.builder, toctree = TocTree(app.env).get_toctree_for('index', app.builder,
collapse=False, maxdepth=3) collapse=False, maxdepth=3)
assert_node(toctree, assert_node(toctree,
[compact_paragraph, ([caption, "Table of Contents"], [compact_paragraph, ([title, "Table of Contents"],
bullet_list, bullet_list,
bullet_list, bullet_list,
bullet_list)]) bullet_list)])
@ -329,7 +329,7 @@ def test_get_toctree_for_includehidden(app):
toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=False, toctree = TocTree(app.env).get_toctree_for('index', app.builder, collapse=False,
includehidden=False) includehidden=False)
assert_node(toctree, assert_node(toctree,
[compact_paragraph, ([caption, "Table of Contents"], [compact_paragraph, ([title, "Table of Contents"],
bullet_list, bullet_list,
bullet_list)]) bullet_list)])

7
tests/test_intl.py
View File

@ -622,11 +622,8 @@ def test_html_meta(app):
assert expected_expr in result assert expected_expr in result
expected_expr = '<meta content="I18N, SPHINX, MARKUP" name="keywords" />' expected_expr = '<meta content="I18N, SPHINX, MARKUP" name="keywords" />'
assert expected_expr in result assert expected_expr in result
if docutils.__version_info__ < (0, 17): expected_expr = '<p class="caption"><span class="caption-text">HIDDEN TOC</span></p>'
expected_expr = '<p class="caption"><span class="caption-text">HIDDEN TOC</span></p>' assert expected_expr in result
assert expected_expr in result
else:
expected_expr = '<p><span class="caption-text">HIDDEN TOC</span></p>'
@sphinx_intl @sphinx_intl