RST Reference
- :iref:ref:
Creates a reference to either a
iref:target
or airef:backlink
.Must use the full syntax of
:iref:ref:`title<id>`
wheretitle
is the text that will be rendered andid
is the ID used to find the target of the reference. Any number of references with the sameid
can be created (they will link to the same place).
- :iref:target:
Creates a target for a reference.
iref:ref
can be used to link to this target.Must use the full syntax of
:iref:target:`title<id>`
wheretitle
is the text that will be rendered andid
is the globally unique ID used to distinguish the target from others.
- :iref:backlink:
Creates a target for a reference, while also creating links back to all the
iref:ref
that link to itself.Must use the full syntax of
:iref:backlink:`title<id>`
wheretitle
is the text that will be rendered andid
is the globally unique ID used to distinguish the target from others.
- :iref:mref:
Creates a link to its paired
iref:mref
while also being a target for the link from its pairediref:mref
.Must use the full syntax of
:iref:mref:`title<id>`
wheretitle
is the text that will be rendered andid
is the globally unique ID used to pair upiref:mref
. Exactly two instances ofiref:mref
must share the sameid
.