lines 6-33 of file: xrst/ref_command.py

{xrst_begin ref_cmd user}

Allow 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
:ref:`heading_links-name` .

New Lines
*********
Newlines and spaces surrounding newlines are removed  from *target* .

Example
*******
:ref:`ref_example-name`

{xrst_end ref_cmd}