Only include inheritance diagram where it's useful.

IPython/config/configurable.py

@@ -2,6 +2,11 b''
 """
 A base class for objects that are configurable.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.config.configurable
+   :parts: 3
+
 Authors:
 
 * Brian Granger

IPython/config/loader.py

@@ -1,5 +1,10 b''
 """A simple configuration system.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.config.loader
+   :parts: 3
+
 Authors
 -------
 * Brian Granger

IPython/core/formatters.py

@@ -1,6 +1,10 b''
 # -*- coding: utf-8 -*-
 """Display formatters.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.core.formatters
+   :parts: 3
 
 Authors:
 

IPython/core/magic_arguments.py

@@ -37,6 +37,11 b' arguments::'
           -o OPTION, --option OPTION
                                 An optional argument.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.core.magic_arguments
+   :parts: 3
+
 '''
 #-----------------------------------------------------------------------------
 # Copyright (C) 2010-2011, IPython Development Team.

IPython/core/ultratb.py

@@ -59,6 +59,11 b' ColorSchemeTable class. Currently the following exist:'
 You can implement other color schemes easily, the syntax is fairly
 self-explanatory. Please send back new schemes you develop to the author for
 possible inclusion in future releases.
+
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.core.ultratb
+   :parts: 3
 """
 
 #*****************************************************************************

IPython/lib/demo.py

@@ -1,6 +1,3 b''
-from __future__ import unicode_literals
-
-
 """Module for interactive demos using IPython.
 
 This module implements a few classes for running Python scripts interactively
@@ -10,7 +7,7 b' control to IPython.'
 
 
 Provided classes
-================
+----------------
 
 The classes are (see their docstrings for further details):
 
@@ -33,9 +30,13 b' The classes are (see their docstrings for further details):'
  - ClearDemo, ClearIPDemo: mixin-enabled versions of the Demo and IPythonDemo
    classes.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.lib.demo
+   :parts: 3
 
 Subclassing
-===========
+-----------
 
 The classes here all include a few methods meant to make customization by
 subclassing more convenient.  Their docstrings below have some more details:
@@ -50,7 +51,7 b' subclassing more convenient. Their docstrings below have some more details:'
 
 
 Operation
-=========
+---------
 
 The file is run in its own empty namespace (though you can pass it a string of
 arguments as if in a command line environment, and it will see those as
@@ -123,10 +124,12 b' an IPython session, and type::'
 and then follow the directions.
 
 Example
-=======
+-------
 
 The following is a very simple example of a valid demo file.
 
+::
+
 #################### EXAMPLE DEMO <ex_demo.py> ###############################
 '''A simple interactive demo to illustrate the use of IPython's Demo class.'''
 
@@ -164,6 +167,8 b" print 'bye!'"
 ################### END EXAMPLE DEMO <ex_demo.py> ############################
 """
 
+from __future__ import unicode_literals
+
 #*****************************************************************************
 #     Copyright (C) 2005-2006 Fernando Perez. <[e-mail]>
 #

IPython/lib/irunner.py

@@ -18,13 +18,11 b' contributed on the ipython-user list:'
 
 http://mail.scipy.org/pipermail/ipython-user/2006-May/003539.html
 
-
-NOTES:
+Notes
+-----
 
  - This module requires pexpect, available in most linux distros, or which can
- be downloaded from
-
-    http://pexpect.sourceforge.net
+   be downloaded from http://pexpect.sourceforge.net
 
  - Because pexpect only works under Unix or Windows-Cygwin, this has the same
  limitations.  This means that it will NOT work under native windows Python.

IPython/lib/pretty.py

@@ -1,8 +1,5 b''
 # -*- coding: utf-8 -*-
 """
-    pretty
-    ~~
-
     Python advanced pretty printer.  This pretty printer is intended to
     replace the old `pprint` python module which does not allow developers
     to provide their own pretty print callbacks.
@@ -11,7 +8,7 b''
 
 
     Example Usage
-    =============
+-------------
 
     To directly print the representation of an object use `pprint`::
 
@@ -25,7 +22,7 b''
 
 
     Extending
-    =========
+---------
 
     The pretty library allows developers to add pretty printing rules for their
     own objects.  This process is straightforward.  All you have to do is to
@@ -97,6 +94,11 b''
     Or under python2.4 you might want to modify ``p.indentation`` by hand but
     this is rather ugly.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.lib.pretty
+   :parts: 3
+
     :copyright: 2007 by Armin Ronacher.
                 Portions (c) 2009 by Robert Kern.
     :license: BSD License.

IPython/parallel/error.py

@@ -2,6 +2,11 b''
 
 """Classes and functions for kernel related errors and exceptions.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.parallel.error
+   :parts: 3
+
 Authors:
 
 * Brian Granger

IPython/utils/text.py

@@ -1,6 +1,11 b''
 # encoding: utf-8
 """
 Utilities for working with strings and text.
+
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.utils.text
+   :parts: 3
 """
 
 #-----------------------------------------------------------------------------

IPython/utils/traitlets.py

@@ -28,6 +28,11 b' We choose to create this module because we need these capabilities, but'
 we need them to be pure Python so they work in all Python implementations,
 including Jython and IronPython.
 
+Inheritance diagram:
+
+.. inheritance-diagram:: IPython.utils.traitlets
+   :parts: 3
+
 Authors:
 
 * Brian Granger

docs/sphinxext/apigen.py

@@ -219,11 +219,6 b' class ApiDocWriter(object):'
             chap_title = ':mod:`' + uri_short + '`'
         ad += chap_title + '\n' + self.rst_section_levels[1] * len(chap_title)
 
-        if len(classes):
-            ad += '\nInheritance diagram for ``%s``:\n\n' % uri
-            ad += '.. inheritance-diagram:: %s \n' % uri
-            ad += '   :parts: 3\n'
-
         ad += '\n.. automodule:: ' + uri + '\n'
         ad += '\n.. currentmodule:: ' + uri + '\n'
         multi_class = len(classes) > 1