Changes between Version 8 and Version 9 of PyDocPlugin

Timestamp:

Jan 11, 2006, 12:57:58 AM (18 years ago)

Author:

Alec Thomas

Comment:

Documented changes by cboos made in [309], [310] and [311].

PyDocPlugin

@@ +1 @@
+[[TOC]]
+
 = Python documentation plugin =
 
@@ -5 +7 @@
 This plugin allows the user to browse Python documentation through Trac's interface.
 
-It also has some additional useful features:
+== Usage ==
 
-  * Provides a `pydoc:object` link for linking to the documentation from other parts of Trac.
-  * Includes a `[[pydoc(object)]]` macro for inlining documentation.
-  * Lets you search the Python documentation from within Trac.
+=== Wiki Links ===
+
+Use `pydoc:object` to link to the documentation for `object`.
+
+=== Inline Expansion of Python Documentation ===
+
+The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline.
+
+`visibility` can be either `public`, `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.
+
+== Configuration ==
+
+All configuration occurs under the [pydoc] section of `trac.ini`.
+
+=== 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.
+
+=== 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.*
+}}}
 
 == Bugs/Feature Requests ==