Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit8fecdde

Browse files
committed
Add intersphinx section
1 parent5747bac commit8fecdde

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

‎doc/devel/documenting_mpl.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,23 @@ An example docstring looks like:
139139
The Sphinx website also contains plenty ofdocumentation_ concerning ReST
140140
markup and working with Sphinx in general.
141141

142+
Linking to other code
143+
---------------------
144+
To link to other methods, classes, or modules in Matplotlib you can encase
145+
the name to refer to in back ticks, for example:
146+
147+
..code-block::python
148+
149+
`~matplotlib.collections.LineCollection`
150+
151+
It is also possible to add links to code in Python, Numpy, Scipy, or Pandas.
152+
Sometimes it is tricky to get external Sphinx linking to work; to check that
153+
a something exists to link to the following shell command outputs a list of all
154+
objects that can be referenced (in this case for Numpy)::
155+
156+
python -m sphinx.ext.intersphinx 'https://docs.scipy.org/doc/numpy/objects.inv'
157+
158+
142159
Function arguments
143160
------------------
144161
Function arguments and keywords within docstrings should be referred to using

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp