apicheck: Removes warning autodirective already registered

Author: ask

Changelog

@@ -1,6 +1,17 @@
 Changes
 =======
 
+.. _version-1.4.8:
+
+1.4.8
+=====
+:release-date: 2019-03-29 12:28 p.m. UTC-8
+
+- apicheck: Removes warning about directive automodule being overridden
+  when running apicheck.
+
+    Tested on :pypi:`Sphinx` versions 1.7.1, 1.8.0, 1.8.5 and 2.0.0.
+
 .. _version-1.4.7:
 
 1.4.7

sphinx_celery/apicheck.py

@@ -63,6 +63,7 @@
 from collections import defaultdict
 from six import string_types
 
+import sphinx
 from sphinx.ext import autodoc
 from sphinx.util.console import bold, darkgreen, green, red
 
@@ -126,7 +127,7 @@ def find_python_modules(package):
     abs = os.path.abspath(current_dist)
     dist_name = os.path.basename(abs)
 
-    for dirpath, dirnames, filenames in os.walk(abs):
+    for dirpath, _, filenames in os.walk(abs):
         package = (dist_name + dirpath[len(abs):]).replace('/', '.')
         if '__init__.py' in filenames:
             yield package
@@ -218,6 +219,24 @@ def as_dict(self):
         }
 
 
+def _add_documenter_override(app, cls):
+    # Install documenter for automodule without generating warning.
+    from sphinx.ext.autodoc.directive import AutodocDirective
+    app.registry.add_documenter(cls.objtype, cls)
+    directive_name = 'auto' + cls.objtype
+    if sphinx.version_info < (1, 8):
+        try:
+            from docutils.parsers.rst import directives
+        except ImportError:
+            pass
+        else:
+            directives._directives.pop(directive_name, None)
+        app.add_directive(directive_name, AutodocDirective)
+    else:
+        # override was added in Sphinx 1.8
+        app.add_directive(directive_name, AutodocDirective, override=True)
+
+
 def setup(app):
     app.add_builder(APICheckBuilder)
     app.add_config_value(
@@ -226,8 +245,8 @@ def setup(app):
         bytes_if_py2('apicheck_domains'), ['py'], False)
     app.add_config_value(
         bytes_if_py2('apicheck_package'), None, False)
-    app.add_autodocumenter(ModuleDocumenter)
+    _add_documenter_override(app, ModuleDocumenter)
 
     return {
-        'parallel_read_safe': True
+        'parallel_read_safe': True,
     }