diff options
| author | Jon Waltman <jonathan.waltman@gmail.com> | 2012-11-03 11:04:32 -0500 |
|---|---|---|
| committer | Jon Waltman <jonathan.waltman@gmail.com> | 2012-11-03 11:04:32 -0500 |
| commit | e962bc0874932d9b7035aa3fa52683421e8be9b0 (patch) | |
| tree | 5e9195bd6e4bd7fb32e9e8ce10a4e83ba3e9d8bd /doc/ext/linkcode.rst | |
| parent | d80c828be2bb5d1a6c8569043301f8a57c5c1c06 (diff) | |
| download | sphinx-e962bc0874932d9b7035aa3fa52683421e8be9b0.tar.gz | |
Fix whitespace / line length issues reported by "make test"
Diffstat (limited to 'doc/ext/linkcode.rst')
| -rw-r--r-- | doc/ext/linkcode.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/ext/linkcode.rst b/doc/ext/linkcode.rst index f05a46f9..a69a5b1c 100644 --- a/doc/ext/linkcode.rst +++ b/doc/ext/linkcode.rst @@ -13,14 +13,14 @@ 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` +In your configuration, you need to specify a :confval:`linkcode_resolve` function that returns an URL based on the object. .. confval:: linkcode_resolve This is a function ``linkcode_resolve(domain, info)``, which should return the URL to source code corresponding to - the object in given domain with given information. + the object in given domain with given information. The function should return ``None`` if no link is to be added. @@ -40,7 +40,7 @@ function that returns an URL based on the object. def linkcode_resolve(domain, info): if domain != 'py': return None - if not info['module']: - return None - filename = info['module'].replace('.', '/') + if not info['module']: + return None + filename = info['module'].replace('.', '/') return "http://somesite/sourcerepo/%s.py" % filename |
