model: Add docstrings to model

This adds docstrings to the model so that Sphinx can parse them. It
also adds some changes to the rst files and conf.py so that inherited
members are shown and special members are not.

9 files changed, 21 insertions, 20 deletions

diff --git a/doc/conf.py b/doc/conf.py
index 0424dc7..988dbf7 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,24 +1,7 @@
 from datetime import datetime
 
-import alabaster
-
-
-html_theme_path = [alabaster.get_path()]
-extensions = ['alabaster']
-html_theme = 'alabaster'
-
-html_theme_options = {
-    'description': "Rumba: A framework to bootstrap a " +
-    "recursive internet network on a testbed."
-}
-
-html_sidebars = {
-    '**': [
-        'about.html',
-        'navigation.html',
-        'searchbox.html'
-    ]
-}
+html_theme = "agogo"
+extensions = []
 
 project = 'Rumba'
 year = datetime.now().year
@@ -30,7 +13,9 @@ default_role = 'obj'
 language = None
 
 extensions.extend(['sphinx.ext.autodoc'])
-autodoc_default_flags = ['members', 'special-members']
+autodoc_default_flags = ['members']
+
+autoclass_content = 'both'
 
 _locals = {}
 with open('../rumba/_version.py') as fp:
diff --git a/doc/docker.rst b/doc/docker.rst
index 004240d..c82d40c 100644
--- a/doc/docker.rst
+++ b/doc/docker.rst
@@ -11,3 +11,5 @@ see `Install Docker <https://docs.docker.com/install/>`_ and complete
 
 .. automodule:: rumba.testbeds.dockertb
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/emulab.rst b/doc/emulab.rst
index 376f07d..77ac3d0 100644
--- a/doc/emulab.rst
+++ b/doc/emulab.rst
@@ -14,3 +14,5 @@ a workaround is to start an ssh-agent and add the public key there. ::
 
 .. automodule:: rumba.testbeds.emulab
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/irati.rst b/doc/irati.rst
index c07feb1..0ad496a 100644
--- a/doc/irati.rst
+++ b/doc/irati.rst
@@ -7,3 +7,5 @@ system, initially developed by the FP7-IRATI project.
 
 .. automodule:: rumba.prototypes.irati
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/jfed.rst b/doc/jfed.rst
index 7ed9e88..3d06c09 100644
--- a/doc/jfed.rst
+++ b/doc/jfed.rst
@@ -28,3 +28,5 @@ or sudo).
 
 .. automodule:: rumba.testbeds.jfed
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/local.rst b/doc/local.rst
index c55a275..6d1ee1d 100644
--- a/doc/local.rst
+++ b/doc/local.rst
@@ -3,3 +3,5 @@ Local
 
 .. automodule:: rumba.testbeds.local
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/ouroboros.rst b/doc/ouroboros.rst
index 785bf92..2b83531 100644
--- a/doc/ouroboros.rst
+++ b/doc/ouroboros.rst
@@ -7,3 +7,5 @@ works on any POSIX.1-2001 enabled system.
 
 .. automodule:: rumba.prototypes.ouroboros
    :member-order: bysource
+   :show-inheritance:
+   :inherited-members:
diff --git a/doc/qemu.rst b/doc/qemu.rst
index ff1ede3..375ab55 100644
--- a/doc/qemu.rst
+++ b/doc/qemu.rst
@@ -11,3 +11,5 @@ bridge-utils packages on which the testbed depends: ::
 
 .. automodule:: rumba.testbeds.qemu
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members:
diff --git a/doc/rlite.rst b/doc/rlite.rst
index f58a16a..418bf3a 100644
--- a/doc/rlite.rst
+++ b/doc/rlite.rst
@@ -7,3 +7,5 @@ Architecture (RINA) for GNU/Linux operating systems.
 
 .. automodule:: rumba.prototypes.rlite
     :member-order: bysource
+    :show-inheritance:
+    :inherited-members: