diff --git a/docs/source/conf.py b/docs/source/conf.py index 90bf50b..d9901db 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -251,3 +251,5 @@ texinfo_documents = [ extlinks = { 'issue': ('https://github.com/dreamhost/stevedore/issues/%s', 'issue '), } + +autodoc_default_flags = ['members', 'special-members', 'show-inheritance'] diff --git a/docs/source/managers.rst b/docs/source/managers.rst index 2b0b527..ff784ee 100644 --- a/docs/source/managers.rst +++ b/docs/source/managers.rst @@ -6,55 +6,36 @@ DriverManager ============= .. autoclass:: stevedore.driver.DriverManager - :members: - :show-inheritance: - :special-members: HookManager =========== .. autoclass:: stevedore.hook.HookManager - :members: - :inherited-members: - :show-inheritance: NamedExtensionManager ===================== .. autoclass:: stevedore.named.NamedExtensionManager - :members: - :show-inheritance: EnabledExtensionManager ======================= .. autoclass:: stevedore.enabled.EnabledExtensionManager - :members: - :inherited-members: - :show-inheritance: DispatchExtensionManager ======================== .. autoclass:: stevedore.dispatch.DispatchExtensionManager - :members: - :inherited-members: - :show-inheritance: NameDispatchExtensionManager ============================ .. autoclass:: stevedore.dispatch.NameDispatchExtensionManager - :members: - :inherited-members: - :show-inheritance: ExtensionManager ================ .. autoclass:: stevedore.extension.ExtensionManager - :members: - :show-inheritance: Extension ========= @@ -62,10 +43,9 @@ Extension .. autoclass:: stevedore.extension.Extension :members: :show-inheritance: + :no-special-members: TestExtensionManager ==================== .. autoclass:: stevedore.tests.manager.TestExtensionManager - :members: - :show-inheritance: diff --git a/stevedore/extension.py b/stevedore/extension.py index 67ba46a..44b2e1d 100644 --- a/stevedore/extension.py +++ b/stevedore/extension.py @@ -45,6 +45,7 @@ class ExtensionManager(object): the object returned by the entry point. Only used if invoke_on_load is True. :type invoke_kwds: dict + """ def __init__(self, namespace, @@ -136,6 +137,11 @@ class ExtensionManager(object): LOG.exception(err) def __iter__(self): + """Produce iterator for the manager. + + Iterating over an ExtensionManager produces the :class:`Extension` + instances in the order they would be invoked. + """ return iter(self.extensions) def __getitem__(self, name):