View source on GitHub
|
Documentation control decorators.
Functions
decorate_all_class_attributes(...): Applies decorator to every attribute defined in cls.
do_not_doc_in_subclasses(...): A decorator: Only generate docs for this method in the defining class.
do_not_doc_inheritable(...): A decorator: Do not generate docs for this method.
do_not_generate_docs(...): A decorator: Do not generate docs for this object.
doc_in_current_and_subclasses(...): Overrides do_not_doc_in_subclasses decorator.
doc_private(...): A decorator: Generates docs for private methods/functions.
for_subclass_implementers(...): A decorator: Only generate docs for this method in the defining class.
get_custom_page_builder_cls(...): Gets custom page content if available.
hide_from_search(...): Marks an object so metadata search hints will not be included on it's page.
set_custom_page_builder_cls(...): Replace most of the generated page with custom content.
set_deprecated(...): Explicitly tag an object as deprecated for the doc generator.
should_hide_from_search(...): Returns true if metadata search hints should not be included.
should_skip(...): Returns true if docs generation should be skipped for this object.
should_skip_class_attr(...): Returns true if docs should be skipped for this class attribute.
Other Members | |
|---|---|
| T |
Instance of typing.TypeVar
|