Skip to content

Commit 256325c

Browse files
committed
only recommend inline form
1 parent baa7680 commit 256325c

File tree

1 file changed

+1
-6
lines changed

1 file changed

+1
-6
lines changed

doc/format.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -605,15 +605,10 @@ Other points to keep in mind
605605

606606
If the Sphinx build issues a warning of the form
607607
``WARNING: Unknown target name: "example"``, then that is what is happening.
608-
There are two possible workarounds. First, the inline form can be used::
608+
To avoid this problem, use the inline hyperlink form::
609609

610610
`Example <http://www.example.com>`_
611611

612-
Second, the hyperlink target can be placed in a section that *is* parsed
613-
as standard reST, such as **Notes**. The inline form is recommended, since
614-
it is more likely to "just work", and not require trial-and-error
615-
experimentation with target placement.
616-
617612

618613
Common reST concepts
619614
--------------------

0 commit comments

Comments
 (0)