Changes between Version 28 and Version 29 of PyDocPlugin

Timestamp:

Dec 9, 2016, 10:05:12 PM (7 years ago)

Author:

figaro

Comment:

Moved example to functional description

PyDocPlugin

@@ -1 +1 @@
 [[PageOutline(2-5,Contents,pullout)]]
 
-= Python documentation plugin
+= Generate Python documentation using pydoc
 
 == Description
@@ -8 +8 @@
 
 It was originally written for Trac 0.9, but there's a fully 0.10 compatible version, as well as a Genshi version for Trac 0.11dev.
+
+Its usage is as follows:
+
+Use `pydoc:trac` to view the Python documentation for Trac.
+
+Use `[[pydoc(os.path.isdir)]]` to inline the documentation for `os.path.isdir()`.
 
 === Alternatives to `pydoc`
@@ -86 +92 @@
 
 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. For example, in order to show the private documentation for Trac and the WebAdmin plugin: 
+The Python private documentation can now be displayed for the modules that are found in this space separated list of module patterns. For example, in order to show the private documentation for Trac and the web administration panel: 
 
 {{{#!ini
@@ -92 +98 @@
 show_private = trac.*  webadmin.*
 }}}
-
-== Example
-
-Use `pydoc:trac` to view the Python documentation for Trac.
-
-Use `[[pydoc(os.path.isdir)]]` to inline the documentation for `os.path.isdir()`.
 
 == Recent Changes