Ticket #6586: inheritance_example.patch

File inheritance_example.patch, 1.6 KB (added by mpatel, 12 years ago)

Example inheritance diagram for "The Steenrod algebra". This is just for fun.

  • doc/common/conf.py

    # HG changeset patch
    # User No Body <nobody@erewhon.borg>
    # Date 1249247616 25200
    # Node ID e69f0537438d5dc87ead8dfa7c1ab3bf15ab017a
    # Parent  2622d455e6f355ded3a294c5a6a1f27f0eb0fe9a
    Sphinx inheritance diagram extension
    
    diff --git a/doc/common/conf.py b/doc/common/conf.py
    a b SAGE_DOC = os.environ['SAGE_ROOT'] + '/d 
    1111
    1212# Add any Sphinx extension module names here, as strings. They can be extensions
    1313# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    14 extensions = ['sphinx.ext.autodoc']
     14extensions = ['sphinx.ext.autodoc',  'sphinx.ext.graphviz',
     15              'sphinx.ext.inheritance_diagram']
     16
     17# GraphViz includes dot, neato, twopi, circo, fdp.
     18graphviz_dot = 'dot'
     19inheritance_graph_attrs = { 'rankdir' : 'BT' }
     20inheritance_node_attrs = { 'height' : 0.5, 'fontsize' : 12, 'shape' : 'oval' }
     21inheritance_edge_attrs = {}
    1522
    1623if 'SAGE_DOC_JSMATH' in os.environ:
    1724    extensions.append('sphinx.ext.jsmath')
  • sage/algebras/steenrod_algebra.py

    diff --git a/sage/algebras/steenrod_algebra.py b/sage/algebras/steenrod_algebra.py
    a b algebra are represented, by default, usi 
    5151See the documentation for ``SteenrodAlgebra`` for many
    5252more details and examples.
    5353
     54HIERARCHY:
     55
     56.. inheritance-diagram::  SteenrodAlgebra_generic
     57                          SteenrodAlgebra_mod_two
     58                          SteenrodAlgebraFactory
     59                          sage.algebras.steenrod_algebra_element.SteenrodAlgebraElement
     60                          :parts: 2
     61
    5462REFERENCES:
    5563
    5664- [Mil] J. W. Milnor, "The Steenrod algebra and its dual," Ann. of