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

Close #5977: :var: field do not create a cross-reference

Browse Source 
Since its beginning, `:var:` field has created a cross-reference to the
attribute having the same name.  It is meaningful only if the attribute
is documented by `py:attribute` directive.  It means the `:var:` field
and `:attr:` role are almost the same and conflicted.  Additionally,
the cross-reference points incorrect variable if the target is not
documented.

Thus, the cross-reference feature of `:var:` field is disabled.
This commit is contained in:
Takeshi KOMIYA 2021-01-01 19:51:59 +09:00
parent 9cac2001f7
commit 918086b559
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -22,6 +22,8 @@ Incompatible changes
``<div>`` ``<div>``
* #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese * #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese
documents documents
* #5977: py domain: ``:var:``, ``:cvar:`` and ``:ivar:`` fields do not create
cross-references
Deprecated Deprecated
---------- ----------

2
sphinx/domains/python.py
View File

@ -354,7 +354,7 @@ class PyObject(ObjectDescription):
'keyword', 'kwarg', 'kwparam'), 'keyword', 'kwarg', 'kwparam'),
typerolename='class', typenames=('paramtype', 'type'), typerolename='class', typenames=('paramtype', 'type'),
can_collapse=True), can_collapse=True),
PyTypedField('variable', label=_('Variables'), rolename='obj', PyTypedField('variable', label=_('Variables'),
names=('var', 'ivar', 'cvar'), names=('var', 'ivar', 'cvar'),
typerolename='class', typenames=('vartype',), typerolename='class', typenames=('vartype',),
can_collapse=True), can_collapse=True),

4
tests/test_domain_py.py
View File

@ -852,14 +852,12 @@ def test_info_field_list_var(app):
# :var int attr: # :var int attr:
assert_node(doctree[1][1][0][0][1][0], assert_node(doctree[1][1][0][0][1][0],
([pending_xref, addnodes.literal_strong, "attr"], ([addnodes.literal_strong, "attr"],
" (", " (",
[pending_xref, addnodes.literal_emphasis, "int"], [pending_xref, addnodes.literal_emphasis, "int"],
")", ")",
" -- ", " -- ",
"blah blah")) "blah blah"))
assert_node(doctree[1][1][0][0][1][0][0], pending_xref,
refdomain="py", reftype="obj", reftarget="attr", **{"py:class": "Class"})
assert_node(doctree[1][1][0][0][1][0][2], pending_xref, assert_node(doctree[1][1][0][0][1][0][2], pending_xref,
refdomain="py", reftype="class", reftarget="int", **{"py:class": "Class"}) refdomain="py", reftype="class", reftarget="int", **{"py:class": "Class"})