\(\newcommand{\B}[1]{ {\bf #1} }\) \(\newcommand{\R}[1]{ {\rm #1} }\)
ref_cmd¶
View page sourceAllow Multiple Lines in Sphinx ref Role¶
Syntax¶
:ref:
` target `:ref:
` linking_text <
target >
`Purpose¶
The xrst program allows one to place a sphinx ref
role target
on multiple lines.
This makes the xrst input more readable
when the headings corresponding to the target are long; see
heading_links .
New Lines¶
Newlines and spaces surrounding newlines are removed from target .