Changes between Version 8 and Version 9 of PyDocPlugin


Ignore:
Timestamp:
Jan 11, 2006 1:57:58 AM (9 years ago)
Author:
athomas
Comment:

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

Legend:

Unmodified
Added
Removed
Modified
  • PyDocPlugin

    v8 v9  
     1[[TOC]] 
     2 
    13= Python documentation plugin = 
    24 
     
    57This plugin allows the user to browse Python documentation through Trac's interface. 
    68 
    7 It also has some additional useful features: 
     9== Usage == 
    810 
    9   * Provides a `pydoc:object` link for linking to the documentation from other parts of Trac. 
    10   * Includes a `[[pydoc(object)]]` macro for inlining documentation. 
    11   * Lets you search the Python documentation from within Trac. 
     11=== Wiki Links === 
     12 
     13Use `pydoc:object` to link to the documentation for `object`. 
     14 
     15=== Inline Expansion of Python Documentation === 
     16 
     17The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline. 
     18 
     19`visibility` can be either `public`, `private` or left empty, in which case the visibility 
     20depends on the [pydoc] show_private setting.  
     21 
     22=== Searching the Python Documentation === 
     23 
     24Documentation searches use the same mechansim as `pydoc -k`. Not ideal, but sufficient. 
     25 
     26== Configuration == 
     27 
     28All configuration occurs under the [pydoc] section of `trac.ini`. 
     29 
     30=== Documentation Search Path === 
     31 
     32The Python documentation will only be displayed for builtin modules and for 
     33the modules listed in the `sys.path` configuration option (use the os.pathsep 
     34character in order to separate the paths). 
     35 
     36If the configuration key is not set, the sys.path variable value will be 
     37used. 
     38 
     39=== Display Private Documentation === 
     40 
     41Added show_private configuration setting for [pydoc]. 
     42 
     43The Python private documentation can now be displayed for the modules 
     44that are found in this space separated list of module patterns. 
     45 
     46e.g. in order to show the private documentation for Trac and the WebAdmin plugin:  
     47 
     48{{{ 
     49[pydoc] 
     50show_private = trac.*  webadmin.* 
     51}}} 
    1252 
    1353== Bugs/Feature Requests ==