diff options
| author | Georg Brandl <georg@python.org> | 2010-04-06 09:23:03 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-04-06 09:23:03 +0200 |
| commit | 5a1b937afaa5b8a4d93bc15f90d69d0e917d9056 (patch) | |
| tree | d4b3d1b1f1fed3c1dd37029cf7fb4a485c765c5f /doc/ext/viewcode.rst | |
| parent | 7f269d3edc077c5e3c3448049eccd393d79a8bdf (diff) | |
| parent | ed65cb87d83af26789f8646c700deec981315579 (diff) | |
| download | sphinx-5a1b937afaa5b8a4d93bc15f90d69d0e917d9056.tar.gz | |
merge with trunk
Diffstat (limited to 'doc/ext/viewcode.rst')
| -rw-r--r-- | doc/ext/viewcode.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/ext/viewcode.rst b/doc/ext/viewcode.rst new file mode 100644 index 00000000..ba6c8f86 --- /dev/null +++ b/doc/ext/viewcode.rst @@ -0,0 +1,19 @@ +:mod:`sphinx.ext.viewcode` -- Add links to highlighted source code +================================================================== + +.. module:: sphinx.ext.viewcode + :synopsis: Add links to a highlighted version of the source code. +.. moduleauthor:: Georg Brandl + +.. versionadded:: 1.0 + + +This extension looks at your Python object descriptions (``.. class::``, +``.. function::`` etc.) and tries to find the source files where the objects are +contained. When found, a separate HTML page will be output for each module with +a highlighted version of the source code, and a link will be added to all object +descriptions that leads to the source code of the described object. A link back +from the source to the description will also be inserted. + +There are currently no configuration values for this extension; you just need to +add ``'sphinx.ext.viewcode'`` to your :confval:`extensions` value for it to work. |