exclude deprecated members from documentation (there are just too many), this can be undone once we've removed the old API (also cleaned up docs/conf.py a little bit). fixes #317

docs/conf.py

@@ -11,7 +11,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os, datetime
+import sys
+import os
+import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -142,10 +144,10 @@ html_sidebars = {
     '**': [
         'sidebarlogo.html',
         'localtoc.html',
-#        'relations.html',
+        #'relations.html',
         'ghbuttons.html',
-#        'sourcelink.html',
+        #'sourcelink.html',
-#        'searchbox.html'
+        #'searchbox.html'
     ]
 }
 
@@ -188,14 +190,14 @@ htmlhelp_basename = 'Jedidoc'
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    #'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    #'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
+    # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -276,3 +278,16 @@ autodoc_default_flags = []
 intersphinx_mapping = {
     'http://docs.python.org/': None,
 }
+
+
+def skip_deprecated(app, what, name, obj, skip, options):
+    """
+    All attributes containing a deprecated note shouldn't be documented
+    anymore. This makes it even clearer that they are not supported anymore.
+    """
+    doc = obj.__doc__
+    return skip or doc and '.. deprecated::' in doc
+
+
+def setup(app):
+    app.connect('autodoc-skip-member', skip_deprecated)