HappyDoc Generated Documentation Class: StructuredTextConverter

HappyDoc3-r3_1 / happydoclib / docstring / docstring_StructuredText.py / StructuredTextConverter 

StructuredText format converter.

This converter supports translating StructuredText (see the StructuredText package) input to HTML output.

Base Classes   

StructuredTextConverter
  happydoclib.happydocstring.HappyDocStringConverterBase

Methods   
  convert 
convert (
        self,
        inputText,
        outputFormat,
        level=3,
        *args,
        *namedArgs,
        )

Returns the inputText data translated into the outputFormat.

Parameters:
inputText
String or other sequence of characters to be converted. This string should be in the format advertised by the docstring converter.
outputFormat
String defined by the docstring converter class to represent a supported output scheme. This value is converter-specific, and not all converters will support the same output formats.
level=3
Beginning indention level for the text. This controls what type of header elements are created among other behaviors.
  _testOutputFormat 
_testOutputFormat ( self,  outputFormat )
Exceptions   

ValueError('Unrecognized output format "%s" for %s.' %( outputFormat, self.__class__.__name__, ) )

  quote 
quote (
        self,
        inputText,
        outputFormat,
        *args,
        *namedArgs,
        )

Returns the inputText quoted in a way that special characters are escaped.

Parameters:
inputText
String or other sequence of characters to be converted. This string should be in the format advertised by the docstring converter.
outputFormat
String defined by the docstring converter class to represent a supported output scheme. This value is converter-specific, and not all converters will support the same output formats.
*args
Additional, converter-specific, positional arguments.
**namedArgs
Additional, converter-specific, named arguments.
  _cleanup 
_cleanup (
        self,
        inputText,
        extractBody=re.compile( '(.*)', re.MULTILINE | re.DOTALL ),
        )

Clean converted text and return new value.

  _unquoteExamplesInST 
_unquoteExamplesInST ( self,  st )

Unquote the characters in all example paragraphs in the ST tree.

  _unquoteHTML 
_unquoteHTML (
        self,
        text,
        character_entities=(( re.compile( '&' ), '&' ), ( re.compile( "<" ), '<' ), ( re.compile( ">" ), '>' ), ( re.compile( '"' ), '"' ) ),
        )

Reverse the quoting process for character entities.


This document was automatically generated Tue Dec 5 08:31:03 2006 by HappyDoc version 3.1