#47 Merged
Repository
pv/sphinx-work sphinx-work
Branch
ext-linkcode
Repository
birkenfeld/sphinx sphinx
Branch
default

sphinx.ext.linkcode

Author
  1. pv avatarpv
Reviewers
Description

Hi,

The extension `sphinx.ext.viewcode` is useful, but bloats the generated documentation by marked-up HTML. Nowadays the source code is often also available on the internet, so it might be useful to have an easy way to put links directly to it.

The attached extension attempts to do this. Because the target of the links may vary quite a lot, it always requires explicit configuration by the user.

Comments (1)

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.