Generate API doc rst files

It also fixes few docstrings

Change-Id: I09b3456e82953f64ec49628e2979115cc7bbec55
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

diff --git a/api/apidoc/functest.core.rst b/api/apidoc/functest.core.rst
index 2dd6d46..fb1c39f 100644 (file)
--- a/api/apidoc/functest.core.rst
+++ b/api/apidoc/functest.core.rst
@@ -1,13 +1,38 @@
 functest.core package
 =====================
 
-.. automodule:: functest.core
+Submodules
+----------
+
+functest.core.cloudify module
+-----------------------------
+
+.. automodule:: functest.core.cloudify
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
-----------
+functest.core.singlevm module
+-----------------------------
+
+.. automodule:: functest.core.singlevm
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. toctree::
+functest.core.tenantnetwork module
+----------------------------------
 
+.. automodule:: functest.core.tenantnetwork
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.core
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.rst b/api/apidoc/functest.opnfv_tests.rst
index 52c2d45..02654db 100644 (file)
--- a/api/apidoc/functest.opnfv_tests.rst
+++ b/api/apidoc/functest.opnfv_tests.rst
@@ -1,10 +1,5 @@
-functest.opnfv_tests package
-============================
-
-.. automodule:: functest.opnfv_tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
+functest.opnfv\_tests package
+=============================
 
 Subpackages
 -----------
@@ -12,3 +7,11 @@ Subpackages
 .. toctree::
 
     functest.opnfv_tests.sdn
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst b/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst
deleted file mode 100644 (file)
index e6f8c73..0000000
--- a/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-functest.opnfv_tests.sdn.odl.odl module
-=======================================
-
-.. automodule:: functest.opnfv_tests.sdn.odl.odl
-    :members:
-    :undoc-members:
-    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.sdn.odl.rst b/api/apidoc/functest.opnfv_tests.sdn.odl.rst
index 60659a1..539fe56 100644 (file)
--- a/api/apidoc/functest.opnfv_tests.sdn.odl.rst
+++ b/api/apidoc/functest.opnfv_tests.sdn.odl.rst
@@ -1,15 +1,22 @@
-functest.opnfv_tests.sdn.odl package
-====================================
+functest.opnfv\_tests.sdn.odl package
+=====================================
 
-.. automodule:: functest.opnfv_tests.sdn.odl
+Submodules
+----------
+
+functest.opnfv\_tests.sdn.odl.odl module
+----------------------------------------
+
+.. automodule:: functest.opnfv_tests.sdn.odl.odl
     :members:
     :undoc-members:
     :show-inheritance:
 
-Submodules
-----------
-
-.. toctree::
 
-   functest.opnfv_tests.sdn.odl.odl
+Module contents
+---------------
 
+.. automodule:: functest.opnfv_tests.sdn.odl
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.sdn.rst b/api/apidoc/functest.opnfv_tests.sdn.rst
index ca8ae77..cdec429 100644 (file)
--- a/api/apidoc/functest.opnfv_tests.sdn.rst
+++ b/api/apidoc/functest.opnfv_tests.sdn.rst
@@ -1,10 +1,5 @@
-functest.opnfv_tests.sdn package
-================================
-
-.. automodule:: functest.opnfv_tests.sdn
-    :members:
-    :undoc-members:
-    :show-inheritance:
+functest.opnfv\_tests.sdn package
+=================================
 
 Subpackages
 -----------
@@ -12,3 +7,11 @@ Subpackages
 .. toctree::
 
     functest.opnfv_tests.sdn.odl
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.sdn
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.rst b/api/apidoc/functest.rst
index 63860f8..b789d05 100644 (file)
--- a/api/apidoc/functest.rst
+++ b/api/apidoc/functest.rst
@@ -1,11 +1,6 @@
 functest package
 ================
 
-.. automodule:: functest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 Subpackages
 -----------
 
@@ -13,3 +8,11 @@ Subpackages
 
     functest.core
     functest.opnfv_tests
+
+Module contents
+---------------
+
+.. automodule:: functest
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/functest/core/tenantnetwork.py b/functest/core/tenantnetwork.py
index 679a934..8d2bb0e 100644 (file)
--- a/functest/core/tenantnetwork.py
+++ b/functest/core/tenantnetwork.py
@@ -11,6 +11,7 @@
 
 It offers a simple way to create all tenant network ressources required by a
 testcase (including all Functest ones):
+
   - TenantNetwork1 selects the user and the project set as env vars
   - TenantNetwork2 creates a user and project to isolate the same ressources