Changes between Version 29 and Version 30 of PyDocPlugin


Ignore:
Timestamp:
Aug 11, 2017, 1:52:20 PM (7 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified
  • PyDocPlugin

    v29 v30  
    1414
    1515Use `[[pydoc(os.path.isdir)]]` to inline the documentation for `os.path.isdir()`.
     16
     17=== Wiki Links
     18
     19Use `pydoc:object` to link to the documentation for `object`.
     20
     21=== Inline Expansion of Python Documentation
     22
     23The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline.
     24
     25The option settings for `visibility` can be either `public`, `private` or left empty, in which case the visibility depends on the [pydoc] show_private setting.
     26
     27=== Searching the Python Documentation
     28
     29Documentation searches use the same mechanism as `pydoc -k`. Not ideal, but sufficient.
    1630
    1731=== Alternatives to `pydoc`
     
    4559General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
    4660
    47 == Usage
    48 
    49 === Wiki Links
    50 
    51 Use `pydoc:object` to link to the documentation for `object`.
    52 
    53 === Inline Expansion of Python Documentation
    54 
    55 The `[[pydoc(target[,visibility])]]` macro will expand the documentation for `object` inline.
    56 
    57 The option settings for `visibility` can be either `public`, `private` or left empty, in which case the visibility depends on the [pydoc] show_private setting.
    58 
    59 === Searching the Python Documentation
    60 
    61 Documentation searches use the same mechansim as `pydoc -k`. Not ideal, but sufficient.
    62 
    6361== Configuration
    6462
    65 All configuration occurs under the [pydoc] section of your `trac.ini` file.
     63All configuration occurs under the `[pydoc]` section of your `trac.ini` file.
    6664
    6765=== Documentation Search Path