/usr/share/doc/sphinx-doc/html/ext/inheritance.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>sphinx.ext.inheritance_diagram – Include inheritance diagrams &mdash; Sphinx 1.2.3 documentation</title>
    
    <link rel="stylesheet" href="../_static/sphinx13.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Sphinx 1.2.3 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="top" title="Sphinx 1.2.3 documentation" href="../index.html" />
    <link rel="up" title="Sphinx Extensions" href="../extensions.html" />
    <link rel="next" title="sphinx.ext.ifconfig – Include content based on configuration" href="ifconfig.html" />
    <link rel="prev" title="sphinx.ext.graphviz – Add Graphviz graphs" href="graphviz.html" />
 
    <style type="text/css">
      table.right { float: right; margin-left: 20px; }
      table.right td { border: 1px solid #ccc; }
      
    </style>
    <script type="text/javascript">
      // intelligent scrolling of the sidebar content
      $(window).scroll(function() {
        var sb = $('.sphinxsidebarwrapper');
        var win = $(window);
        var sbh = sb.height();
        var offset = $('.sphinxsidebar').position()['top'];
        var wintop = win.scrollTop();
        var winbot = wintop + win.innerHeight();
        var curtop = sb.position()['top'];
        var curbot = curtop + sbh;
        // does sidebar fit in window?
        if (sbh < win.innerHeight()) {
          // yes: easy case -- always keep at the top
          sb.css('top', $u.min([$u.max([0, wintop - offset - 10]),
                                $(document).height() - sbh - 200]));
        } else {
          // no: only scroll if top/bottom edge of sidebar is at
          // top/bottom edge of window
          if (curtop > wintop && curbot > winbot) {
            sb.css('top', $u.max([wintop - offset - 10, 0]));
          } else if (curtop < wintop && curbot < winbot) {
            sb.css('top', $u.min([winbot - sbh - offset - 20,
                                  $(document).height() - sbh - 200]));
          }
        }
      });
    </script>

  </head>
  <body>
<div class="pageheader">
  <ul>
    <li><a href="../index.html">Home</a></li>
    <li><a href="../install.html">Get it</a></li>
    <li><a href="../contents.html">Docs</a></li>
    <li><a href="../develop.html">Extend/Develop</a></li>
  </ul>
  <div>
    <a href="../index.html">
      <img src="../_static/sphinxheader.png" alt="SPHINX" />
    </a>
  </div>
</div>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="ifconfig.html" title="sphinx.ext.ifconfig – Include content based on configuration"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="graphviz.html" title="sphinx.ext.graphviz – Add Graphviz graphs"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">Sphinx home</a>&nbsp;|</li>
        <li><a href="../contents.html">Documentation</a> &raquo;</li>

          <li><a href="../extensions.html" accesskey="U">Sphinx Extensions</a> &raquo;</li> 
      </ul>
    </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h4>Previous topic</h4>
  <p class="topless"><a href="graphviz.html"
                        title="previous chapter"><tt class="docutils literal"><span class="pre">sphinx.ext.graphviz</span></tt> &#8211; Add Graphviz graphs</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="ifconfig.html"
                        title="next chapter"><tt class="docutils literal"><span class="pre">sphinx.ext.ifconfig</span></tt> &#8211; Include content based on configuration</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/ext/inheritance.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-sphinx.ext.inheritance_diagram">
<span id="sphinx-ext-inheritance-diagram-include-inheritance-diagrams"></span><h1><a class="reference internal" href="#module-sphinx.ext.inheritance_diagram" title="sphinx.ext.inheritance_diagram: Support for displaying inheritance diagrams via graphviz."><tt class="xref py py-mod docutils literal"><span class="pre">sphinx.ext.inheritance_diagram</span></tt></a> &#8211; Include inheritance diagrams<a class="headerlink" href="#module-sphinx.ext.inheritance_diagram" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
<p><span class="versionmodified">New in version 0.6.</span></p>
</div>
<p>This extension allows you to include inheritance diagrams, rendered via the
<a class="reference internal" href="graphviz.html#module-sphinx.ext.graphviz" title="sphinx.ext.graphviz: Support for Graphviz graphs."><tt class="xref py py-mod docutils literal"><span class="pre">Graphviz</span> <span class="pre">extension</span></tt></a>.</p>
<p>It adds this directive:</p>
<dl class="directive">
<dt id="directive-inheritance-diagram">
<tt class="descname">.. inheritance-diagram::</tt><a class="headerlink" href="#directive-inheritance-diagram" title="Permalink to this definition">¶</a></dt>
<dd><p>This directive has one or more arguments, each giving a module or class
name.  Class names can be unqualified; in that case they are taken to exist
in the currently described module (see <a class="reference internal" href="../domains.html#directive-py:module" title="py:module directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">py:module</span></tt></a>).</p>
<p>For each given class, and each class in each given module, the base classes
are determined.  Then, from all classes and their base classes, a graph is
generated which is then rendered via the graphviz extension to a directed
graph.</p>
<p>This directive supports an option called <tt class="docutils literal"><span class="pre">parts</span></tt> that, if given, must be an
integer, advising the directive to remove that many parts of module names
from the displayed names.  (For example, if all your class names start with
<tt class="docutils literal"><span class="pre">lib.</span></tt>, you can give <tt class="docutils literal"><span class="pre">:parts:</span> <span class="pre">1</span></tt> to remove that prefix from the displayed
node names.)</p>
<p>It also supports a <tt class="docutils literal"><span class="pre">private-bases</span></tt> flag option; if given, private base
classes (those whose name starts with <tt class="docutils literal"><span class="pre">_</span></tt>) will be included.</p>
<div class="versionchanged">
<p><span class="versionmodified">Changed in version 1.1: </span>Added <tt class="docutils literal"><span class="pre">private-bases</span></tt> option; previously, all bases were always
included.</p>
</div>
</dd></dl>

<p>New config values are:</p>
<dl class="confval">
<dt id="confval-inheritance_graph_attrs">
<tt class="descname">inheritance_graph_attrs</tt><a class="headerlink" href="#confval-inheritance_graph_attrs" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary of graphviz graph attributes for inheritance diagrams.</p>
<p>For example:</p>
<div class="highlight-rest"><div class="highlight"><pre>inheritance_graph_attrs = dict(rankdir=&quot;LR&quot;, size=&#39;&quot;6.0, 8.0&quot;&#39;,
                               fontsize=14, ratio=&#39;compress&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="confval">
<dt id="confval-inheritance_node_attrs">
<tt class="descname">inheritance_node_attrs</tt><a class="headerlink" href="#confval-inheritance_node_attrs" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary of graphviz node attributes for inheritance diagrams.</p>
<p>For example:</p>
<div class="highlight-rest"><div class="highlight"><pre>inheritance_node_attrs = dict(shape=&#39;ellipse&#39;, fontsize=14, height=0.75,
                              color=&#39;dodgerblue1&#39;, style=&#39;filled&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="confval">
<dt id="confval-inheritance_edge_attrs">
<tt class="descname">inheritance_edge_attrs</tt><a class="headerlink" href="#confval-inheritance_edge_attrs" title="Permalink to this definition">¶</a></dt>
<dd><p>A dictionary of graphviz edge attributes for inheritance diagrams.</p>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="ifconfig.html" title="sphinx.ext.ifconfig – Include content based on configuration"
             >next</a> |</li>
        <li class="right" >
          <a href="graphviz.html" title="sphinx.ext.graphviz – Add Graphviz graphs"
             >previous</a> |</li>
        <li><a href="../index.html">Sphinx home</a>&nbsp;|</li>
        <li><a href="../contents.html">Documentation</a> &raquo;</li>

          <li><a href="../extensions.html" >Sphinx Extensions</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2007-2014, Georg Brandl and the Sphinx team.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
    </div>
  </body>
</html>
sphinx-doc 1.2.3+dfsg-1 / usr / share / doc / sphinx-doc / html / ext / inheritance.html
