Skip to content

Add documentation on hyperlinks #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 24, 2017
Merged

Add documentation on hyperlinks #124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baa7680
add documentation on hyperlinks
weaverba137 Oct 23, 2017
256325c
only recommend inline form
weaverba137 Oct 23, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/format.rst
View file
Open in desktop
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