Skip to content

Commit

Permalink
DOC Add documentation on hyperlinks (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
jnothman committed Oct 24, 2017
2 parents 55d1560 + 256325c commit f901007
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions doc/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,19 @@ Other points to keep in mind
(i.e. scalar types, sequence types), those arguments can be documented
with type `array_like`.

* Links : If you need to include hyperlinks in your docstring, note that
some docstring sections are not parsed as standard reST, and in these
sections, numpydoc may become confused by hyperlink targets such as::

.. _Example: http://www.example.com

If the Sphinx build issues a warning of the form
``WARNING: Unknown target name: "example"``, then that is what is happening.
To avoid this problem, use the inline hyperlink form::

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


Common reST concepts
--------------------
For paragraphs, indentation is significant and indicates indentation in the
Expand Down

0 comments on commit f901007

Please sign in to comment.