Merge pull request #100 from theOehrly/cleanup

Type hint mixin base class, fix some more minor style and typing issues

Author: Chilipp

autodocsumm/__init__.py

@@ -40,6 +40,7 @@
 __status__ = "Production"
 
 from itertools import chain
+from typing import TYPE_CHECKING
 
 from sphinx.util import logging
 import re
@@ -53,7 +54,7 @@
 from sphinx.ext.autodoc import (
     ClassDocumenter, ModuleDocumenter, ALL, PycodeError,
     ModuleAnalyzer, AttributeDocumenter, DataDocumenter, Options,
-    prepare_docstring)
+    Documenter, prepare_docstring)
 import sphinx.ext.autodoc as ad
 
 signature = Signature = None
@@ -82,6 +83,12 @@ def force_decode(string: str, encoding: str) -> str:
 __version__ = _version.get_versions()['version']
 
 
+if TYPE_CHECKING:  # pragma: no cover
+    DOCUMENTER_MIXIN_BASE = Documenter
+else:
+    DOCUMENTER_MIXIN_BASE = object
+
+
 logger = logging.getLogger(__name__)
 
 #: Options of the :class:`sphinx.ext.autodoc.ModuleDocumenter` that have an
@@ -125,7 +132,7 @@ def _get_arg(param, pos, default, *args, **kwargs):
         return default
 
 
-class AutosummaryDocumenter(object):
+class AutosummaryDocumenter(DOCUMENTER_MIXIN_BASE):
     """Abstract class for for extending Documenter methods
 
     This classed is used as a base class for Documenters in order to provide
@@ -137,6 +144,8 @@ class AutosummaryDocumenter(object):
     #: Grouper functions
     grouper_funcs = []
 
+    member_sections: dict
+
     def __init__(self):
         raise NotImplementedError
 
@@ -287,7 +296,6 @@ def get_grouped_documenters(self, all_members=False):
         else:
             return documenters
 
-
     def add_autosummary(self, relative_ref_paths=False):
         """Add the autosammary table of this documenter.