summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2012-03-11 17:55:29 +0100
committerPauli Virtanen <pav@iki.fi>2012-03-11 17:55:29 +0100
commitbb8d2307d28803acab6f1d3aab7e83dcd0d114b9 (patch)
treea53c6ce5db3d4bf15b1b3ed07e8b706944216ddf /doc
parente85f2467852ec4d42e4f4ed147bd64ef2907517d (diff)
downloadsphinx-bb8d2307d28803acab6f1d3aab7e83dcd0d114b9.tar.gz
DOC: linkcode: fix up documentation a bit
Diffstat (limited to 'doc')
-rw-r--r--doc/ext/linkcode.rst11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/ext/linkcode.rst b/doc/ext/linkcode.rst
index 9ae24756..a4ac394c 100644
--- a/doc/ext/linkcode.rst
+++ b/doc/ext/linkcode.rst
@@ -7,15 +7,14 @@
.. versionadded:: 1.1
-This extension looks at your Python object descriptions
-(``.. class::``, ``.. function::`` etc.) and adds external links to
-code hosted somewhere on the web. The intent is similar to the
+This extension looks at your object descriptions (``.. class::``,
+``.. function::`` etc.) and adds external links to code hosted
+somewhere on the web. The intent is similar to the
``sphinx.ext.viewcode`` extension, but assumes the source code can be
found somewhere on the Internet.
In your configuration, you need to specify a :confval:`linkcode_resolve`
-function that returns an URL based on the name of a module and
-the full name of the object.
+function that returns an URL based on the object.
.. confval:: linkcode_resolve
@@ -29,9 +28,9 @@ the full name of the object.
in. ``info`` is a dictionary with the following keys guaranteed to
be present (dependent on the domain):
+ - ``py``: ``module`` (name of the module), ``fullname`` (name of the object)
- ``c``: ``names`` (list of names for the object)
- ``cpp``: ``names`` (list of names for the object)
- - ``py``: ``module`` (name of the module), ``fullname`` (name of the object)
- ``javascript``: ``object`` (name of the object), ``fullname`` (name of the item)
Example: