Merge pull request #37 from Chilipp/check-module

Check module

Author: Chilipp

.gitignore

@@ -62,3 +62,5 @@ target/
 
 # Example ipython notebook checkpoints
 *.ipynb_checkpoints/
+
+.mypy_cache

autodocsumm/__init__.py

@@ -206,6 +206,8 @@ def get_grouped_documenters(self, all_members=False):
             if self.env.app:
                 e[0].parse_name()
                 e[0].import_object()
+                if members_check_module and not e[0].check_module():
+                    continue
                 user_section = self.env.app.emit_firstresult(
                     'autodocsumm-grouper', self.objtype, e[0].object_name,
                     e[0].object, section, self.object)

tests/sphinx_supp/empty.py

@@ -0,0 +1,5 @@
+"""Empty module just to test if product is imported or not
+
+see https://github.com/Chilipp/autodocsumm/issues/32
+"""
+from itertools import product

tests/sphinx_supp/index.rst

@@ -15,3 +15,4 @@ Example documentation
     test_autoclasssumm_no_titles
     test_automodulesumm
     test_automodulesumm_some_sections
+    test_empty

tests/sphinx_supp/test_empty.rst

@@ -0,0 +1,7 @@
+Test of empty module
+====================
+
+see https://github.com/Chilipp/autodocsumm/issues/32
+
+.. automodule:: empty
+    :members:

tests/test_autodocsumm.py

@@ -309,7 +309,14 @@ def test_automodulesumm_some_sections(self, app, status, warning):
         self.assertIn('<span class="pre">large_data</span>', html)
         self.assertIn('<span class="pre">test_func</span>', html)
 
+    @with_app(buildername='html', srcdir=sphinx_supp,
+              copy_srcdir_to_tmpdir=True)
+    def test_empty(self, app, status, warning):
+        app.build()
+
+        html = get_html(app, '/test_empty.html')
 
+        self.assertNotIn('<span class="pre">product</span>', html)
 
 
 if __name__ == '__main__':