Package eggbasket :: Module rest
[hide private]

Module rest

source code

rest-to-html conversion taken from the Zope core This implementation requires docutils 0.4.0+ from http://docutils.sf.net/

Classes [hide private]
  Warnings
Functions [hide private]
 
render(src, writer='html4css1', report_level=1, stylesheet=None, input_encoding='unicode', output_encoding='unicode', language_code='en', initial_header_level=3, settings={})
get the rendered parts of the document the and warning object
source code
 
HTML(src, writer='html4css1', report_level=1, stylesheet=None, input_encoding='unicode', output_encoding='unicode', language_code='en', initial_header_level=3, warnings=None, settings={})
render HTML from a reStructuredText string
source code
Variables [hide private]
  version = ['0', '4']
  default_enc = 'ascii'
  default_output_encoding = 'unicode'
  default_input_encoding = 'unicode'
  default_level = 3
  initial_header_level = 3
  default_language_code = 'en'
  conf = {'action': 'store_true', 'default': 0, 'dest': 'file_in...
  options = ['--file-insertion-enabled']
  title = 'Enable directives that insert the contents of externa...
Function Details [hide private]

HTML(src, writer='html4css1', report_level=1, stylesheet=None, input_encoding='unicode', output_encoding='unicode', language_code='en', initial_header_level=3, warnings=None, settings={})

source code 
render HTML from a reStructuredText string 

- 'src'  -- string containing a valid reST document

- 'writer' -- docutils writer 

- 'report_level' - verbosity of reST parser

- 'stylesheet' - Stylesheet to be used

- 'input_encoding' - encoding of the reST input string

- 'output_encoding' - encoding of the rendered HTML output

- 'report_level' - verbosity of reST parser

- 'language_code' - docutils language

- 'initial_header_level' - level of the first header tag

- 'warnings' - will be overwritten with a string containing the warnings

- 'settings' - dict of settings to pass in to Docutils, with priority


Variables Details [hide private]

conf

Value:
{'action': 'store_true',
 'default': 0,
 'dest': 'file_insertion_enabled'}

title

Value:
'Enable directives that insert the contents of external file ("include\
" & "raw").  Enabled by default.'