Add documentation on hyperlinks #124
Conversation
doc/format.rst
Outdated
| ``WARNING: Unknown target name: "example"``, then that is what is happening. | ||
| There are two possible workarounds. First, the inline form can be used:: | ||
|
|
||
| `Example <http://www.example.com>`_ |
There was a problem hiding this comment.
Should this be `Example <http://www.example.com`__ ?
There was a problem hiding this comment.
I'm pretty sure that inline hyperlink targets need a closing > and one underscore, not two. Please see http://docutils.sourceforge.net/docs/user/rst/quickref.html#hyperlink-targets
There was a problem hiding this comment.
The missing > was a typo; I was concerned with what happens when you have similar inline references in different docstrings.
doc/format.rst
Outdated
|
|
||
| `Example <http://www.example.com>`_ | ||
|
|
||
| Second, the hyperlink target can be placed in a section that *is* parsed |
There was a problem hiding this comment.
I suggest we only recommend a version that will always work; if we choose to parse the Notes section differently later on, this may break. Others may disagree; I don't feel strongly.
There was a problem hiding this comment.
I'm OK with that.
|
Thanks @weaverba137 |
This PR fixes #116 by adding documentation on how to handle hyperlink targets in docstrings.