pydocmk2.preprocessors.smart
pydocmk2.preprocessors.smart
Classes
class Preprocessor(builtin.object)
This class implements the preprocessor for restructured text and google.
Methods
- init(self, config=None)
- is_google_format(self, docstring)
-
Check if `docstring` is written in Google docstring format https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
- 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.smart.Preprocessor = class Preprocessor(__builtin__.object)
This class implements the preprocessor for restructured text and google.
Methods
- __init__(self, config=None)
- is_google_format(self, docstring)
-
Check if `docstring` is written in Google docstring format https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
- 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)
is_google_format
- pydocmk2.preprocessors.smart.Preprocessor.is_google_format = is_google_format(self, docstring) unbound pydocmk2.preprocessors.smart.Preprocessor method
-
Check if `docstring` is written in Google docstring format https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
preprocess_section
- pydocmk2.preprocessors.smart.Preprocessor.preprocess_section = preprocess_section(self, section) unbound pydocmk2.preprocessors.smart.Preprocessor method
-
Preprocessors a given section into it's components.