pv avatar pv committed 1b67a77

DOC: linkcode: fix up documentation a bit

Comments (0)

Files changed (1)

doc/ext/linkcode.rst

 
 .. 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
 
    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:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.