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

Fix broken handling of whitespace in GenericObject.

Browse Source 
This actually makes the code matches its comment, i.e, whitespaces are now
normalized the same way XRefRole does.

Without the fix, when creating a directive/role via add_object_type, the
following testcase fails with "WARNING: 'baz' reference target not found:
foo bar".

    :baz:`foo bar`
    .. baz:: foo bar

The current workaround is to explicitly mention the broken target, e.g.,

    :baz:`foo bar <foobar>`
    .. baz:: foo bar
This commit is contained in:
Guillaume Melquiond 2020-02-18 08:07:11 +01:00
parent ee0656f51f
commit cea18198ce
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/domains/std.py
View File

@ -62,7 +62,7 @@ class GenericObject(ObjectDescription):
signode.clear() signode.clear()
signode += addnodes.desc_name(sig, sig) signode += addnodes.desc_name(sig, sig)
# normalize whitespace like XRefRole does # normalize whitespace like XRefRole does
name = ws_re.sub('', sig) name = ws_re.sub(' ', sig)
return name return name
def add_target_and_index(self, name: str, sig: str, signode: desc_signature) -> None: def add_target_and_index(self, name: str, sig: str, signode: desc_signature) -> None: