

pydocmk2.preprocessors.simple

pydocmk2.preprocessors.simple

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

Modules

• re

Classes

• builtin.object
• • Preprocessor

class Preprocessor(builtin.object)

This class implements the basic preprocessing.

Methods

init(self, config)

preprocess_section(self, section)

Preprocess the contents of *section*.

Descriptors

dict

dictionary for instance variables (if defined)

weakref

list of weak references to the object (if defined)

Preprocessor

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

This class implements the basic preprocessing.

Methods

__init__(self, config)

preprocess_section(self, section)

Preprocess the contents of *section*.

Descriptors

__dict__

dictionary for instance variables (if defined)

__weakref__

list of weak references to the object (if defined)

preprocess_section

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

Preprocess the contents of *section*.