changeset 1418:cbfa7ea6dae7

doc: added inheritance diagrams
author Martin Geisler <mg@cs.au.dk>
date Mon, 14 Dec 2009 13:01:24 +0100
parents abf0c99aff35
children f264239b594d
files doc/active.txt doc/comparison.txt doc/conf.py doc/field.txt doc/orlandi.txt doc/paillier.txt doc/passive.txt doc/runtime.txt
diffstat 8 files changed, 37 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/active.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/active.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -7,9 +7,15 @@
    .. autoclass:: ActiveRuntime
       :members:
 
+      .. inheritance-diagram:: ActiveRuntime
+         :parts: 1
+
    .. autoclass:: BasicActiveRuntime
       :members:
 
+      .. inheritance-diagram:: BasicActiveRuntime
+         :parts: 1
+
    .. autoclass:: BrachaBroadcastMixin
       :members:
 
--- a/doc/comparison.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/comparison.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -19,7 +19,13 @@
 
 .. autoclass:: viff.comparison.Toft05Runtime
 
+   .. inheritance-diagram:: viff.comparison.Toft05Runtime
+      :parts: 1
+
 .. autoclass:: viff.comparison.ComparisonToft07Mixin
    :members: greater_than_equal
 
 .. autoclass:: viff.comparison.Toft07Runtime
+
+   .. inheritance-diagram:: viff.comparison.Toft07Runtime
+      :parts: 1
--- a/doc/conf.py	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/conf.py	Mon Dec 14 13:01:24 2009 +0100
@@ -31,7 +31,8 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig',
+              'sphinx.ext.inheritance_diagram']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
--- a/doc/field.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/field.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -10,6 +10,9 @@
       :members: __add__, __mul__, __pow__, __div__, __neg__,
                 __invert__, __eq__, __nonzero__, __int__
 
+      .. inheritance-diagram:: GF256
+         :parts: 1
+
       .. attribute:: GF256.modulus
 
          Field modulus, always 256.
--- a/doc/orlandi.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/orlandi.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -10,6 +10,11 @@
    .. autoclass:: OrlandiShare
       :members:
 
+      .. inheritance-diagram:: OrlandiShare
+         :parts: 1
+
    .. autoclass:: OrlandiRuntime
       :members:
 
+      .. inheritance-diagram:: OrlandiRuntime
+         :parts: 1
--- a/doc/paillier.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/paillier.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -7,6 +7,9 @@
    .. autoclass:: PaillierRuntime
       :members:
 
+      .. inheritance-diagram:: PaillierRuntime
+         :parts: 1
+
    .. autofunction:: encrypt
 
    .. autofunction:: decrypt
--- a/doc/passive.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/passive.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -6,3 +6,6 @@
 
    .. autoclass:: PassiveRuntime
       :members:
+
+       .. inheritance-diagram:: PassiveRuntime
+          :parts: 1
--- a/doc/runtime.txt	Mon Dec 14 12:12:28 2009 +0100
+++ b/doc/runtime.txt	Mon Dec 14 13:01:24 2009 +0100
@@ -6,6 +6,9 @@
 
    .. autoclass:: Share
 
+      .. inheritance-diagram:: Share
+         :parts: 1
+
       .. automethod:: Share.__init__
 
       .. automethod:: Share.clone
@@ -23,11 +26,17 @@
 
    .. autoclass:: ShareList
 
+      .. inheritance-diagram:: ShareList
+         :parts: 1
+
    .. autofunction gather_shares
 
    .. autoclass:: ShareExchanger
       :members: sendShare, sendData, loseConnection
 
+      .. inheritance-diagram:: ShareExchanger
+         :parts: 1
+
       .. attribute:: ShareExchanger.incoming_data
 
          Data from our peer is put here, either as an empty