This module implements the Trac components for the
RstDoc TracPlugin.
- Imports:
- docutils, docutils.core, docutils.utils, os, os.path, rstdoc.misclibs.functional, rstdoc.misclibs.util, rstdoc.rstlib, rstdoc.traclib, sys, textwrap, trac.Search, trac.core, trac.util, trac.web.chrome, trac.web.main, trac.wiki.api, urllib
- Classes:
- Documenter(object): I generate the documenation as required by the
various components.
- RstDocNav(Component): If enabled, a RstDoc menu item will be added
to the Trac main menu.
- RstDocRequestHandler(Component): I must be enabled if any other rstdoc components are
enabled.
- RstDocWikiMacro(Component): When enabled, generates documentation from the repository.
- RstDocWikiSyntax(Component): If enabled, the rstdoc:target wiki syntax can be
used to link to documentation.
- RstFileWikiMacro(Component): When enabled, display reStructured text inline from
a file in the repository.
- Methods:
- Markup(markup):
Back to plugin
- Bases:
- object
I generate the documenation as required by the
various components.
- Methods:
- __init__(self, env, config):
- generate_docs(self, target, req, node):
- generate_error(self, target, req):
- generate_tree(self, target, req, node):
- processRequest(self, req, target, rstFile=False):
Back to plugin.Documenter
- Arguments:
- self, target, req, node
- Methods:
- formatDocString(paragraphs, path, name): The paragraphs argument is a list of 0
or more docutils.nodes.paragraph nodes
as returned by the astdoc.docString function.
This method processes the first paragraph
to add the Module name and hyperlink.
- tree(path, node): Recursively build tree.
Back to plugin.Documenter.generate_tree
- Arguments:
- path, node
Recursively build tree.
- Methods:
- getEntries(node): For each entry in node, determine the
node type (module, normal file, or directory) and
yield a tuple containing the entry's type, name,
and doc string (for modules) as well as the entry
itself. A list of these tuples is sorted to
order the definition list items.
Back to plugin
- Bases:
- Component
If enabled, a RstDoc menu item will be added
to the Trac main menu.
- Methods:
- get_active_navigation_item(self, req):
- get_navigation_items(self, req):
Back to plugin
- Bases:
- Component
When enabled, generates documentation from the repository.
Macro syntax: [[rstdoc(target)]]
- Methods:
- get_macro_description(self, name):
- get_macros(self):
- render_macro(self, req, name, content):
Back to plugin
- Bases:
- Component
If enabled, the rstdoc:target wiki syntax can be
used to link to documentation.
- Methods:
- _rstdoc_formatter(self, formatter, ns, object, label):
- get_link_resolvers(self):
- get_wiki_syntax(self):
Back to plugin
- Bases:
- Component
When enabled, display reStructured text inline from
a file in the repository.
Macro syntax: [[rstfile(target)]]
- Methods:
- get_macro_description(self, name):
- get_macros(self):
- render_macro(self, req, name, content):