Skip to content

Commit f901007

Browse files
authored
DOC Add documentation on hyperlinks (#124)
2 parents 55d1560 + 256325c commit f901007

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

doc/format.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -597,6 +597,19 @@ Other points to keep in mind
597597
(i.e. scalar types, sequence types), those arguments can be documented
598598
with type `array_like`.
599599

600+
* Links : If you need to include hyperlinks in your docstring, note that
601+
some docstring sections are not parsed as standard reST, and in these
602+
sections, numpydoc may become confused by hyperlink targets such as::
603+
604+
.. _Example: http://www.example.com
605+
606+
If the Sphinx build issues a warning of the form
607+
``WARNING: Unknown target name: "example"``, then that is what is happening.
608+
To avoid this problem, use the inline hyperlink form::
609+
610+
`Example <http://www.example.com>`_
611+
612+
600613
Common reST concepts
601614
--------------------
602615
For paragraphs, indentation is significant and indicates indentation in the

0 commit comments

Comments
 (0)