Package trac :: Package mimeview :: Module rst

Module rst

source code


Version: 0.7

Classes
  ReStructuredTextRenderer
HTML renderer for plain text in reStructuredText format.
Functions
 
raw_role(role, rawtext, text, lineno, inliner, options={}, content=[]) source code
 
trac_get_reference(env, context, rawtext, target, text) source code
 
trac_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
Inserts a reference node into the document for a given TracLink, based on the content of the arguments.
source code
 
trac_role(name, rawtext, text, lineno, inliner, options={}, content=[]) source code
 
code_formatter(env, context, language, text) source code
 
code_block_role(name, rawtext, text, lineno, inliner, options={}, content=[]) source code
 
code_block_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
Create a code-block directive for docutils.
source code
Variables
  has_docutils = True
  __package__ = 'trac.mimeview'

Imports: StrictVersion, nodes, publish_parts, rst, ISystemInfoProvider, IHTMLPreviewRenderer, content_to_unicode, Element, Fragment, Markup, find_element, _, WikiSystem, WikiProcessor, Formatter, extract_link, roles, Component, ExtensionPoint, Interface, TracError, implements


Function Details

trac_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

source code 

Inserts a reference node into the document for a given TracLink, based on the content of the arguments.

Usage:

.. trac:: target [text]

target may be any TracLink, provided it doesn't embed a space character (e.g. wiki:"..." notation won't work).

[text] is optional. If not given, target is used as the reference text.

code_block_directive(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

source code 

Create a code-block directive for docutils.

Usage: .. code-block:: language

If the language can be syntax highlighted it will be.