lemon.external.epydoc.markup.epytext

Package lemon :: Package external :: Package epydoc :: Package markup :: Module epytext

[show private | hide private]

Module lemon.external.epydoc.markup.epytext

Parser for epytext strings. Epytext is a lightweight markup whose primary intended application is Python documentation strings. This parser converts Epytext strings to a XML/DOM representation. Epytext strings can contain the following structural blocks:

epytext: The top-level element of the DOM tree.
para: A paragraph of text. Paragraphs contain no newlines, and all spaces are soft.
section: A section or subsection.
field: A tagged field. These fields provide information about specific aspects of a Python object, such as the description of a function's parameter, or the author of a module.
literalblock: A block of literal text. This text should be displayed as it would be displayed in plaintext. The parser removes the appropriate amount of leading whitespace from each line in the literal block.
doctestblock: A block containing sample python code, formatted according to the specifications of the doctest module.
ulist: An unordered list.
olist: An ordered list.
li: A list item. This tag is used both for unordered list items and for ordered list items.

Additionally, the following inline regions may be used within para blocks:

code: Source code and identifiers.
math: Mathematical expressions.
index: A term which should be included in an index, if one is generated.
italic: Italicized text.
bold: Bold-faced text.
uri: A Universal Resource Indicator (URI) or Universal Resource Locator (URL)
link: A Python identifier which should be hyperlinked to the named object's documentation, when possible.

The returned DOM tree will conform to the the following Document Type Description:

  <!ENTITY % colorized '(code | math | index | italic |
                         bold | uri | link | symbol)*'>

  <!ELEMENT epytext ((para | literalblock | doctestblock |
                     section | ulist | olist)*, fieldlist?)>

  <!ELEMENT para (#PCDATA | %colorized;)*>

  <!ELEMENT section (para | listblock | doctestblock |
                     section | ulist | olist)+>

  <!ELEMENT fieldlist (field+)>
  <!ELEMENT field (tag, arg?, (para | listblock | doctestblock)
                               ulist | olist)+)>
  <!ELEMENT tag (#PCDATA)>
  <!ELEMENT arg (#PCDATA)>
  
  <!ELEMENT literalblock (#PCDATA)>
  <!ELEMENT doctestblock (#PCDATA)>

  <!ELEMENT ulist (li+)>
  <!ELEMENT olist (li+)>
  <!ELEMENT li (para | literalblock | doctestblock | ulist | olist)+>
  <!ATTLIST li bullet NMTOKEN #IMPLIED>
  <!ATTLIST olist start NMTOKEN #IMPLIED>

  <!ELEMENT uri     (name, target)>
  <!ELEMENT link    (name, target)>
  <!ELEMENT name    (#PCDATA | %colorized;)*>
  <!ELEMENT target  (#PCDATA)>
  
  <!ELEMENT code    (#PCDATA | %colorized;)*>
  <!ELEMENT math    (#PCDATA | %colorized;)*>
  <!ELEMENT italic  (#PCDATA | %colorized;)*>
  <!ELEMENT bold    (#PCDATA | %colorized;)*>
  <!ELEMENT indexed (#PCDATA | %colorized;)>

  <!ELEMENT symbol (#PCDATA)>

Classes
`ParsedEpytextDocstring`
`Token`	`Token`s are an intermediate data structure used while constructing the structuring DOM tree for a formatted docstring.

Exceptions
`ColorizingError`	An error generated while colorizing a paragraph.
`StructuringError`	An error generated while structuring a formatted documentation string.
`TokenizationError`	An error generated while tokenizing a formatted documentation string.

Variable Summary
`list`	`SYMBOLS`: A list of the of escape symbols that are supported by epydoc.

Variable Details

SYMBOLS

A list of the of escape symbols that are supported by epydoc. Currently the following symbols are supported: S{<-}=←; S{->}=→; S{^}=↑; S{v}=↓; S{alpha}=α; S{beta}=β; S{gamma}=γ; S{delta}=δ; S{epsilon}=ε; S{zeta}=ζ; S{eta}=η; S{theta}=θ; S{iota}=ι; S{kappa}=κ; S{lambda}=λ; S{mu}=μ; S{nu}=ν; S{xi}=ξ; S{omicron}=ο; S{pi}=π; S{rho}=ρ; S{sigma}=σ; S{tau}=τ; S{upsilon}=υ; S{phi}=φ; S{chi}=χ; S{psi}=ψ; S{omega}=ω; S{Alpha}=Α; S{Beta}=Β; S{Gamma}=Γ; S{Delta}=Δ; S{Epsilon}=Ε; S{Zeta}=Ζ; S{Eta}=Η; S{Theta}=Θ; S{Iota}=Ι; S{Kappa}=Κ; S{Lambda}=Λ; S{Mu}=Μ; S{Nu}=Ν; S{Xi}=Ξ; S{Omicron}=Ο; S{Pi}=Π; S{Rho}=Ρ; S{Sigma}=Σ; S{Tau}=Τ; S{Upsilon}=Υ; S{Phi}=Φ; S{Chi}=Χ; S{Psi}=Ψ; S{Omega}=Ω; S{larr}=←; S{rarr}=→; S{uarr}=↑; S{darr}=↓; S{harr}=↔; S{crarr}=↵; S{lArr}=⇐; S{rArr}=⇒; S{uArr}=⇑; S{dArr}=⇓; S{hArr}=⇔; S{copy}=©; S{times}=×; S{forall}=∀; S{exist}=∃; S{part}=∂; S{empty}=∅; S{isin}=∈; S{notin}=∉; S{ni}=∋; S{prod}=∏; S{sum}=∑; S{prop}=∝; S{infin}=∞; S{ang}=∠; S{and}=∧; S{or}=∨; S{cap}=∩; S{cup}=∪; S{int}=∫; S{there4}=∴; S{sim}=∼; S{cong}=≅; S{asymp}=≈; S{ne}=≠; S{equiv}=≡; S{le}=≤; S{ge}=≥; S{sub}=⊂; S{sup}=⊃; S{nsub}=⊄; S{sube}=⊆; S{supe}=⊇; S{oplus}=⊕; S{otimes}=⊗; S{perp}=⊥; S{infinity}=∞; S{integral}=∫; S{product}=∏; S{>=}=≥; S{<=}=≤

Type:: list
Value:: ['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'delta', 'epsilon']

Generated by Epydoc 2.0 on Mon Nov 10 15:08:34 2003

http://epydoc.sf.net