Changes between Version 25 and Version 26 of PyDocPlugin


Ignore:
Timestamp:
Jun 16, 2015, 8:33:39 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with 'documentation'

Legend:

Unmodified
Added
Removed
Modified

  • PyDocPlugin

    v25 v26  
    77This plugin allows the user to browse Python documentation through Trac's interface, using the `pydoc` documentation system.
    88
    9 It was originally written for Trac 0.9, but there's now a fully 0.10 compatible version, and even a Genshi version for Trac 0.11dev.
     9It 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.
    1010
    1111== Alternatives to `pydoc`
    1212
    13 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 [https://svn.enthought.com/enthought/wiki/EndoHowTo Endo] (promising), [http://effbot.org/zone/pythondoc.htm PythonDoc] (promising), [http://happydoc.sourceforge.net/ Happy Doc] and [http://codespeak.net/svn/user/mwh/pydoctor/trunk/ PyDoctor] (requires trunk version of some divmod modules, couldn't get it working).
     13Tools that use static code analysis would be preferable to those that compile the Python code and inspect the doc strings. Some tools that do this are [https://svn.enthought.com/enthought/wiki/EndoHowTo Endo] (promising), [http://effbot.org/zone/pythondoc.htm PythonDoc] (promising), [http://happydoc.sourceforge.net/ Happy Doc] and [http://codespeak.net/svn/user/mwh/pydoctor/trunk/ PyDoctor] (requires trunk version of some divmod modules, couldn't get it working).
    1414
    15 Others are [http://pudge.lesscode.org/ Pudge] and [http://epydoc.sourceforge.net/ EpyDoc]. [http://epydoc.sourceforge.net/ EpyDoc] is fully supported by EpyDocPlugin.
     15Others are [http://pudge.lesscode.org/ Pudge] and [http://epydoc.sourceforge.net/ EpyDoc] (fully supported by the EpyDocPlugin).
    1616
    1717== Bugs/Feature Requests
    … …  
    2121
    2222If you have any issues, create a
    23 [http://trac-hacks.org/newticket?component=PyDocPlugin&owner=athomas new ticket].
     23[/newticket?component=PyDocPlugin new ticket].
    2424
    2525[[TicketQuery(component=PyDocPlugin&group=type,format=progress)]]
    … …  
    2828
    2929Download the zipped source corresponding to your Trac version:
    30 || Trac  0.9 || [download:pydocplugin/0.9 pydocplugin/0.9] ||
     30|| Trac 0.9 || [download:pydocplugin/0.9 pydocplugin/0.9] ||
    3131|| Trac 0.10 || [download:pydocplugin/0.10 pydocplugin/0.10] ||
    3232|| Trac 0.11 || [download:pydocplugin/0.11 pydocplugin/0.11] ||
    … …  
    4646The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline.
    4747
    48 `visibility` can be either `public`, `private` or left empty, in which case the visibility depends on the [pydoc] show_private setting.
     48The option settings for `visibility` can be either `public`, `private` or left empty, in which case the visibility depends on the [pydoc] show_private setting.
    4949
    5050=== Searching the Python Documentation
    … …  
    5454== Configuration
    5555
    56 All configuration occurs under the [pydoc] section of `trac.ini`.
     56All configuration occurs under the [pydoc] section of your `trac.ini` file.
    5757
    5858=== Documentation Search Path
    … …  
    6565This is a glob, so you will need appropriate wildcards to match correctly. For example, to display all DBM modules except anydbm:
    6666
    67 {{{
    68 #!ini
     67{{{#!ini
    6968[pydoc]
    7069include = *dbm*
    … …  
    7473To display just the Trac documentation:
    7574
    76 {{{
    77 #!ini
     75{{{#!ini
    7876[pydoc]
    7977include = trac trac.*
    … …  
    8785The 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:
    8886
    89 {{{
    90 #!ini
     87{{{#!ini
    9188[pydoc]
    9289show_private = trac.*  webadmin.*
    … …  
    108105'''Contributors:''' [[Maintainer]] [[BR]]
    109106'''Authors:''' [wiki:athomas] [wiki:cboos][[BR]]
    110 
    111 
    112 
    113