Merge pull request #61 from Chilipp/fix-warnings

Fix warnings

Author: Chilipp

README.rst

@@ -128,6 +128,7 @@ directives by adding in ``conf.py``:
 Disclaimer
 ==========
 Copyright 2016-2019, Philipp S. Sommer
+
 Copyright 2020-2021, Helmholtz-Zentrum Hereon
 
 Licensed under the Apache License, Version 2.0 (the "License");

autodocsumm/__init__.py

@@ -10,6 +10,7 @@
 **Disclaimer**
 
 Copyright 2016-2019, Philipp S. Sommer
+
 Copyright 2020-2021, Helmholtz-Zentrum Hereon
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -38,7 +39,7 @@
 
 __status__ = "Production"
 
-__version__ = '0.2.5'
+__version__ = '0.2.6'
 
 from itertools import chain
 
@@ -181,6 +182,10 @@ def get_grouped_documenters(self, all_members=False):
         self.real_modname = None or self.get_real_modname()
 
         # try to also get a source code analyzer for attribute docs
+        if sphinx_version < [4, 0]:
+            record_dependencies = self.directive.filename_set
+        else:
+            record_dependencies = self.directive.record_dependencies
         try:
             self.analyzer = ModuleAnalyzer.for_module(self.real_modname)
             # parse right now, to get PycodeErrors on parsing (results will
@@ -192,9 +197,9 @@ def get_grouped_documenters(self, all_members=False):
             self.analyzer = None
             # at least add the module.__file__ as a dependency
             if hasattr(self.module, '__file__') and self.module.__file__:
-                self.directive.filename_set.add(self.module.__file__)
+                record_dependencies.add(self.module.__file__)
         else:
-            self.directive.filename_set.add(self.analyzer.srcname)
+            record_dependencies.add(self.analyzer.srcname)
 
         self.env.temp_data['autodoc:module'] = self.modname
         if self.objpath:
@@ -487,9 +492,8 @@ def get_doc(self, *args, **kwargs):
                     docstring = force_decode(docstring, encoding)
                 doc.append(prepare_docstring(docstring, ignore))
         else:
-            ignore = _get_arg("ignore", 0, 1, *args, **kwargs)
             for docstring in docstrings:
-                doc.append(prepare_docstring(docstring, ignore))
+                doc.append(prepare_docstring(docstring))
 
         return doc
 

docs/api/autodocsumm.rst

@@ -3,6 +3,5 @@ API Reference
 
 .. automodule:: autodocsumm
     :members:
-    :undoc-members:
     :show-inheritance:
 

docs/conf.py

@@ -69,9 +69,9 @@
 add_module_names = False
 
 # General information about the project.
-project = u'autodocsumm'
-copyright = u'2015, Philipp Sommer'
-author = u'Philipp Sommer'
+project = 'autodocsumm'
+copyright = '2016-2019, Philipp S. Sommer; 2020-2021, Helmholtz-Zentrum Hereon'
+author = 'Philipp S. Sommer'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -137,11 +137,6 @@
     html_theme = 'sphinx_rtd_theme'
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
-    # Add any paths that contain custom static files (such as style sheets) here,
-    # relative to this directory. They are copied after the builtin static files,
-    # so a file named "default.css" will overwrite the builtin "default.css".
-    html_static_path = ['_static']
-
 # otherwise, readthedocs.org uses their theme by default, so no need to specify
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -385,12 +380,9 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'sphinx': ('http://www.sphinx-doc.org/en/master/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
+    'python': ('https://docs.python.org/3.9/', None),
 }
-if six.PY3:
-    intersphinx_mapping['python'] = ('https://docs.python.org/3.7/', None)
-else:
-    intersphinx_mapping['python'] = ('https://docs.python.org/2.7/', None)
 
 
 def example_grouper(app, what, name, obj, section, parent):

docs/conf_settings.rst

@@ -71,9 +71,9 @@ Directives
     use the same options as for the ``autoclass`` directive. You can select a
     specific section and omit the title via::
 
-    .. autoclasssumm:: MyClass
-        :autosummary-sections: Methods
-        :autosummary-no-titles:
+        .. autoclasssumm:: MyClass
+            :autosummary-sections: Methods
+            :autosummary-no-titles:
 
     By default, this directives also sets the `:members:` option unless you
     specify `:no-members`.

docs/index.rst

@@ -127,7 +127,7 @@ directives to generate a table at the top, e.g.:
 
 .. code-block:: rst
 
-    .. automodule:: my.awesome.module
+    .. automodule:: autodocsumm
         :autosummary:
 
 Optionally, you can make autodocsumm active by default for all autodoc
@@ -144,6 +144,7 @@ directives by adding:
 Disclaimer
 ==========
 Copyright 2016-2019, Philipp S. Sommer
+
 Copyright 2020-2021, Helmholtz-Zentrum Hereon
 
 Licensed under the Apache License, Version 2.0 (the "License");

setup.py

@@ -11,15 +11,15 @@ def readme():
 
 
 setup(name='autodocsumm',
-      version='0.2.5',
+      version='0.2.6',
       description='Extended sphinx autodoc including automatic autosummaries',
       long_description=readme(),
       long_description_content_type='text/x-rst',
       classifiers=[
         'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'Topic :: Documentation',
-        'License :: OSI Approved :: GNU General Public License v2 (GPLv2)',
+        'License :: OSI Approved :: Apache Software License',
         'Programming Language :: Python :: 3',
         'Programming Language :: Python :: 3 :: Only',
         'Programming Language :: Python :: 3.5',