need_incoming
/ need_outgoing
/ need_part
misuse sphinx reference role
#1437
Labels
need_incoming
/ need_outgoing
/ need_part
misuse sphinx reference role
#1437
The anatomy of a reference role is that
title == target
, e.g.:name:`target`
<>
, e.g.:name:`title <target>`
!
, e.g.:name:`!target`
or:name:`!title <target>`
<
or!
can be escaped with\
, e.g.:name:`title \<target>`
or:name:`\!target`
Firstly, it is of note that for all
need
/need_incoming
/need_outgoing
/need_part
, they are set assphinx.XRefRole
.For all of these, the disabling of the role with
!
works, i.e. a reference/part is not created for these.It is not clear if this is even intended, nor is it documented.
For the title/target syntax, the
need
role works as expected.For
need_incoming
/need_outgoing
/need_part
, though this syntax is parsed, it is not used in an understandable way:e.g. for
:name:`title <target>`
,need_incoming
/need_outgoing
only thetarget
is used and thetitle
is disregardedneed_part
only thetitle
is used and thetarget
is disregardedAdditionally,
need_part
, splits up id/content like(id) content
, but does not account for space in between the)
and start of contentalso there is no warning if
need_part
is not in a need directive, they are just silently ignoredThe text was updated successfully, but these errors were encountered: