

pydocmk2.preprocessors.google

pydocmk2.preprocessors.google

Modules

• re

Classes

• Preprocessor

class Preprocessor

This class implements the preprocessor for Google and PEP 257 docstrings.

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
https://www.python.org/dev/peps/pep-0257/

Methods

init(self, config=None)

get_section_names(self)

preprocess_section(self, section)

Preprocessors a given section into it's components.

Preprocessor

pydocmk2.preprocessors.google.Preprocessor = class Preprocessor

This class implements the preprocessor for Google and PEP 257 docstrings.

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
https://www.python.org/dev/peps/pep-0257/

Methods

__init__(self, config=None)

get_section_names(self)

preprocess_section(self, section)

Preprocessors a given section into it's components.

preprocess_section

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

Preprocessors a given section into it's components.