IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

DOC: linkcode: fix up documentation a bit

Browse Source
This commit is contained in:
Pauli Virtanen
2012-03-11 17:55:29 +01:00
parent 135bb6f6c8
commit da4ba903a3
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/ext/linkcode.rst
View File

@@ -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: