|Version 20 (modified by 10 years ago) (diff),|
Python documentation plugin
This plugin allows the user to browse Python documentation through Trac's interface.
Tools that use static code analysis would be much more preferable to those that compile the Python code and inspect the doc strings. Some tools that do this are Endo (promising), PythonDoc (promising), Happy Doc and PyDoctor (requires trunk version of some divmod modules, couldn't get it working).
pydoc:object to link to the documentation for
Inline Expansion of Python Documentation
[[pydoc(target[,visibility])]] macro will expand the documentation for
visibility can be either
private or left empty, in which case the visibility
depends on the [pydoc] show_private setting.
Searching the Python Documentation
Documentation searches use the same mechansim as
pydoc -k. Not ideal, but sufficient.
All configuration occurs under the [pydoc] section of
Documentation Search Path
The Python documentation will only be displayed for builtin modules and for
the modules listed in the
sys.path configuration option (use the os.pathsep
character in order to separate the paths).
If the configuration key is not set, the sys.path variable value will be used.
In addition, the index can also be filtered through an include/exclude list. This is a glob, so you will need appropriate wildcards to match correctly. For example, to display all DBM modules except anydbm:
[pydoc] include = *dbm* exclude = anydbm
To display just the Trac documentation:
[pydoc] include = trac trac.*
Note: You will need both
trac.* as browsing matches against the module name and searching matches against the full object name.
Display Private Documentation
Added show_private configuration setting for [pydoc].
The Python private documentation can now be displayed for the modules that are found in this space separated list of module patterns.
e.g. in order to show the private documentation for Trac and the WebAdmin plugin:
[pydoc] show_private = trac.* webadmin.*
If you have any issues, create a new ticket.
Download the zipped source from [download:pydocplugin here].
pydoc:trac to view the Python documentation for Trac.
[[pydoc(os.path.isdir)]] to inline the documentation for