Changes between Version 24 and Version 25 of PyDocPlugin


Ignore:
Timestamp:
Mar 18, 2015, 9:41:30 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • PyDocPlugin

    v24 v25  
    1 [[PageOutline]]
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Python documentation plugin =
     3= Python documentation plugin
    44
    5 == Description ==
     5== Description
    66
    7 This plugin allows the user to browse Python documentation through Trac's interface,
    8 using the `pydoc` documentation system.
     7This plugin allows the user to browse Python documentation through Trac's interface, using the `pydoc` documentation system.
    98
    10 It was originally written for Trac 0.9, but there's now a fully 0.10 compatible version,
    11 and even a Genshi version for Trac 0.11dev.
     9It 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.
    1210
    13 == Alternatives to `pydoc` ==
     11== Alternatives to `pydoc`
    1412
    15 Tools that use static code analysis would be much more preferable to those that
    16 compile the Python code and inspect the doc strings. Some tools that do this
    17 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
    18 [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 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).
    1914
    20 Others are [http://pudge.lesscode.org/ Pudge] and [http://epydoc.sourceforge.net/ EpyDoc].
    21 [http://epydoc.sourceforge.net/ EpyDoc] is fully supported by EpyDocPlugin.
     15Others are [http://pudge.lesscode.org/ Pudge] and [http://epydoc.sourceforge.net/ EpyDoc]. [http://epydoc.sourceforge.net/ EpyDoc] is fully supported by EpyDocPlugin.
    2216
    23 == Usage ==
     17== Bugs/Feature Requests
    2418
    25 === Wiki Links ===
     19Existing bugs and feature requests for PyDocPlugin are
     20[report:9?COMPONENT=PyDocPlugin here].
     21
     22If you have any issues, create a
     23[http://trac-hacks.org/newticket?component=PyDocPlugin&owner=athomas new ticket].
     24
     25[[TicketQuery(component=PyDocPlugin&group=type,format=progress)]]
     26
     27== Download
     28
     29Download the zipped source corresponding to your Trac version:
     30|| Trac  0.9 || [download:pydocplugin/0.9 pydocplugin/0.9] ||
     31|| Trac 0.10 || [download:pydocplugin/0.10 pydocplugin/0.10] ||
     32|| Trac 0.11 || [download:pydocplugin/0.11 pydocplugin/0.11] ||
     33
     34== Source
     35
     36You can check out PyDocPlugin from [http://trac-hacks.org/svn/pydocplugin here] using Subversion, or [source:pydocplugin browse the source] with Trac.
     37
     38== Usage
     39
     40=== Wiki Links
    2641
    2742Use `pydoc:object` to link to the documentation for `object`.
    2843
    29 === Inline Expansion of Python Documentation ===
     44=== Inline Expansion of Python Documentation
    3045
    3146The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline.
    3247
    33 `visibility` can be either `public`, `private` or left empty, in which case the visibility
    34 depends on the [pydoc] show_private setting.
     48`visibility` can be either `public`, `private` or left empty, in which case the visibility depends on the [pydoc] show_private setting.
    3549
    36 === Searching the Python Documentation ===
     50=== Searching the Python Documentation
    3751
    3852Documentation searches use the same mechansim as `pydoc -k`. Not ideal, but sufficient.
    3953
    40 == Configuration ==
     54== Configuration
    4155
    4256All configuration occurs under the [pydoc] section of `trac.ini`.
    4357
    44 === Documentation Search Path ===
     58=== Documentation Search Path
    4559
    46 The Python documentation will only be displayed for builtin modules and for
    47 the modules listed in the `sys.path` configuration option (use the `os.pathsep`
    48 character in order to separate the paths).
     60The 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.
    4961
    50 If the configuration key is not set, the `sys.path` variable value will be
    51 used.
     62If the configuration key is not set, the `sys.path` variable value will be used.
    5263
    5364In addition, the index can also be filtered through an include/exclude list.
    54 This is a glob, so you will need appropriate wildcards to match correctly.
    55 For example, to display all DBM modules except anydbm:
     65This is a glob, so you will need appropriate wildcards to match correctly. For example, to display all DBM modules except anydbm:
    5666
    5767{{{
     68#!ini
    5869[pydoc]
    5970include = *dbm*
    … …  
    6475
    6576{{{
     77#!ini
    6678[pydoc]
    6779include = trac trac.*
    … …  
    7082'''Note:''' You will need both `trac` and `trac.*` as browsing matches against the module name and searching matches against the full object name.
    7183
    72 === Display Private Documentation ===
     84=== Display Private Documentation
    7385
    7486Added `show_private` configuration setting for `[pydoc]`.
    75 
    76 The Python private documentation can now be displayed for the modules
    77 that are found in this space separated list of module patterns.
    78 
    79 e.g. in order to show the private documentation for Trac and the WebAdmin plugin:
     87The 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:
    8088
    8189{{{
     90#!ini
    8291[pydoc]
    8392show_private = trac.*  webadmin.*
    8493}}}
    8594
    86 == Bugs/Feature Requests ==
    87 
    88 Existing bugs and feature requests for PyDocPlugin are
    89 [report:9?COMPONENT=PyDocPlugin here].
    90 
    91 If you have any issues, create a
    92 [http://trac-hacks.org/newticket?component=PyDocPlugin&owner=athomas new ticket].
    93 
    94 == Download ==
    95 
    96 Download the zipped source corresponding to your Trac version:
    97 || Trac  0.9 || [download:pydocplugin/0.9 pydocplugin/0.9] ||
    98 || Trac 0.10 || [download:pydocplugin/0.10 pydocplugin/0.10] ||
    99 || Trac 0.11 || [download:pydocplugin/0.11 pydocplugin/0.11] ||
    100 
    101 == Source ==
    102 
    103 You can check out PyDocPlugin from [http://trac-hacks.org/svn/pydocplugin here] using Subversion, or [source:pydocplugin browse the source] with Trac.
    104 
    105 == Example ==
     95== Example
    10696
    10797Use `pydoc:trac` to view the Python documentation for Trac.
    … …  
    10999Use `[[pydoc(os.path.isdir)]]` to inline the documentation for `os.path.isdir()`.
    110100
    111 == Author/Contributors ==
     101== Recent Changes
     102
     103[[ChangeLog(pydocplugin, 3)]]
     104
     105== Author/Contributors
    112106
    113107'''Author:''' [wiki:athomas] [[BR]]
    114 '''Contributors:''' [wiki:cboos] [[BR]]
    115 
    116 [[TagIt(plugin,athomas,0.9,0.10,cboos)]]
     108'''Contributors:''' [[Maintainer]] [[BR]]
     109'''Authors:''' [wiki:athomas] [wiki:cboos][[BR]]
    117110
    118111