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

autosectionlabel: Rename confval to autosectionlabel_maxdepth

Browse Source
This commit is contained in:
Takeshi KOMIYA 2019-02-11 18:07:57 +09:00
parent d548bf98f5
commit 4250b197c5
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -186,7 +186,7 @@ Features added
* #5924: githubpages: create CNAME file for custom domains when
:confval:`html_baseurl` set
* #4261: autosectionlabel: restrict the labeled sections by new config value;
:confval:`autosectionlabel_max_depth`
:confval:`autosectionlabel_maxdepth`
Bugs fixed

6
sphinx/ext/autosectionlabel.py
View File

@ -44,8 +44,8 @@ def register_sections_as_label(app, document):
labels = app.env.domaindata['std']['labels']
anonlabels = app.env.domaindata['std']['anonlabels']
for node in document.traverse(nodes.section):
if (app.config.autosectionlabel_max_depth and
get_node_depth(node) > app.config.autosectionlabel_max_depth):
if (app.config.autosectionlabel_maxdepth and
get_node_depth(node) > app.config.autosectionlabel_maxdepth):
continue
labelid = node['ids'][0]
docname = app.env.docname
@ -69,7 +69,7 @@ def register_sections_as_label(app, document):
def setup(app):
# type: (Sphinx) -> Dict[str, Any]
app.add_config_value('autosectionlabel_prefix_document', False, 'env')
app.add_config_value('autosectionlabel_max_depth', None, 'env')
app.add_config_value('autosectionlabel_maxdepth', None, 'env')
app.connect('doctree-read', register_sections_as_label)
return {

4
tests/test_ext_autosectionlabel.py
View File

@ -71,7 +71,7 @@ def test_autosectionlabel_prefix_document_html(app, status, warning):
@pytest.mark.sphinx('html', testroot='ext-autosectionlabel',
confoverrides={'autosectionlabel_max_depth': 2})
def test_autosectionlabel_max_depth(app, status, warning):
confoverrides={'autosectionlabel_maxdepth': 2})
def test_autosectionlabel_maxdepth(app, status, warning):
return test_autosectionlabel_html(app, status, warning,
skipped_labels=True)