

pydocmk2.preprocessors.rst

pydocmk2.preprocessors.rst

This module implements preprocessing Markdown-like docstrings and converts
it to fully markdown compatible markup.

Modules

• re
• textwrap

Classes

• builtin.object
• • Preprocessor

class Preprocessor(builtin.object)

This class implements the preprocessor for restructured text.

Methods

init(self, config=None)

preprocess_section(self, section)

Preprocessors a given section into it's components.

Descriptors

dict

dictionary for instance variables (if defined)

weakref

list of weak references to the object (if defined)

Preprocessor

pydocmk2.preprocessors.rst.Preprocessor = class Preprocessor(__builtin__.object)

This class implements the preprocessor for restructured text.

Methods

__init__(self, config=None)

preprocess_section(self, section)

Preprocessors a given section into it's components.

Descriptors

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

preprocess_section

pydocmk2.preprocessors.rst.Preprocessor.preprocess_section = preprocess_section(self, section) unbound pydocmk2.preprocessors.rst.Preprocessor method

Preprocessors a given section into it's components.