Generate API doc rst files

It also fixes few docstrings

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

diff --git a/api/apidoc/functest.ci.rst b/api/apidoc/functest.ci.rst
new file mode 100644 (file)
index 0000000..576fc22
--- /dev/null
+++ b/api/apidoc/functest.ci.rst
@@ -0,0 +1,22 @@
+functest.ci package
+===================
+
+Submodules
+----------
+
+functest.ci.check\_deployment module
+------------------------------------
+
+.. automodule:: functest.ci.check_deployment
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.ci
+    :members:
+    :undoc-members:
+    :show-inheritance:

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.openstack.api.rst b/api/apidoc/functest.opnfv_tests.openstack.api.rst
new file mode 100644 (file)
index 0000000..209f807
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.api.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.api package
+===========================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.api.connection\_check module
+------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.api.connection_check
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.api
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.cinder.rst b/api/apidoc/functest.opnfv_tests.openstack.cinder.rst
new file mode 100644 (file)
index 0000000..dc2c93b
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.cinder.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.cinder package
+==============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.cinder.cinder\_test module
+----------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.cinder.cinder_test
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.cinder
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.patrole.rst b/api/apidoc/functest.opnfv_tests.openstack.patrole.rst
new file mode 100644 (file)
index 0000000..72679f3
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.patrole.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.patrole package
+===============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.patrole.patrole module
+------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.patrole.patrole
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.patrole
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.rally.rst b/api/apidoc/functest.opnfv_tests.openstack.rally.rst
new file mode 100644 (file)
index 0000000..377b822
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.rally.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.rally package
+=============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.rally.rally module
+--------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.rally.rally
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.rally
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.refstack.rst b/api/apidoc/functest.opnfv_tests.openstack.refstack.rst
new file mode 100644 (file)
index 0000000..a35e944
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.refstack.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.refstack package
+================================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.refstack.refstack module
+--------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.refstack.refstack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.refstack
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.rst b/api/apidoc/functest.opnfv_tests.openstack.rst
new file mode 100644 (file)
index 0000000..f883cba
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.rst
@@ -0,0 +1,27 @@
+functest.opnfv\_tests.openstack package
+=======================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    functest.opnfv_tests.openstack.api
+    functest.opnfv_tests.openstack.cinder
+    functest.opnfv_tests.openstack.patrole
+    functest.opnfv_tests.openstack.rally
+    functest.opnfv_tests.openstack.refstack
+    functest.opnfv_tests.openstack.shaker
+    functest.opnfv_tests.openstack.snaps
+    functest.opnfv_tests.openstack.tempest
+    functest.opnfv_tests.openstack.vgpu
+    functest.opnfv_tests.openstack.vmtp
+    functest.opnfv_tests.openstack.vping
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.shaker.rst b/api/apidoc/functest.opnfv_tests.openstack.shaker.rst
new file mode 100644 (file)
index 0000000..fb298cb
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.shaker.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.shaker package
+==============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.shaker.shaker module
+----------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.shaker.shaker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.shaker
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.snaps.rst b/api/apidoc/functest.opnfv_tests.openstack.snaps.rst
new file mode 100644 (file)
index 0000000..dd78620
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.snaps.rst
@@ -0,0 +1,62 @@
+functest.opnfv\_tests.openstack.snaps package
+=============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.snaps.api\_check module
+-------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.api_check
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.snaps.health\_check module
+----------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.health_check
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.snaps.smoke module
+--------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.smoke
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.snaps.snaps\_suite\_builder module
+------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.snaps_suite_builder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.snaps.snaps\_test\_runner module
+----------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.snaps_test_runner
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.snaps.snaps\_utils module
+---------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps.snaps_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.snaps
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.tempest.rst b/api/apidoc/functest.opnfv_tests.openstack.tempest.rst
new file mode 100644 (file)
index 0000000..5eceffe
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.tempest.rst
@@ -0,0 +1,30 @@
+functest.opnfv\_tests.openstack.tempest package
+===============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.tempest.conf\_utils module
+----------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.tempest.conf_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.tempest.tempest module
+------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.tempest.tempest
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.tempest
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.vgpu.rst b/api/apidoc/functest.opnfv_tests.openstack.vgpu.rst
new file mode 100644 (file)
index 0000000..59fdc28
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.vgpu.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.vgpu package
+============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.vgpu.vgpu module
+------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.vgpu.vgpu
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.vgpu
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.vmtp.rst b/api/apidoc/functest.opnfv_tests.openstack.vmtp.rst
new file mode 100644 (file)
index 0000000..311dffb
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.vmtp.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.openstack.vmtp package
+============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.vmtp.vmtp module
+------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.vmtp.vmtp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.vmtp
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.openstack.vping.rst b/api/apidoc/functest.opnfv_tests.openstack.vping.rst
new file mode 100644 (file)
index 0000000..828eecb
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.openstack.vping.rst
@@ -0,0 +1,30 @@
+functest.opnfv\_tests.openstack.vping package
+=============================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.openstack.vping.vping\_ssh module
+-------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.vping.vping_ssh
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.openstack.vping.vping\_userdata module
+------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.openstack.vping.vping_userdata
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.openstack.vping
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.rst b/api/apidoc/functest.opnfv_tests.rst
index 52c2d45..7d50b4d 100644 (file)
--- a/api/apidoc/functest.opnfv_tests.rst
+++ b/api/apidoc/functest.opnfv_tests.rst
@@ -1,14 +1,19 @@
-functest.opnfv_tests package
-============================
-
-.. automodule:: functest.opnfv_tests
-    :members:
-    :undoc-members:
-    :show-inheritance:
+functest.opnfv\_tests package
+=============================
 
 Subpackages
 -----------
 
 .. toctree::
 
+    functest.opnfv_tests.openstack
     functest.opnfv_tests.sdn
+    functest.opnfv_tests.vnf
+
+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.opnfv_tests.vnf.epc.rst b/api/apidoc/functest.opnfv_tests.vnf.epc.rst
new file mode 100644 (file)
index 0000000..d159bb0
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.epc.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.vnf.epc package
+=====================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.vnf.epc.juju\_epc module
+----------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.epc.juju_epc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf.epc
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.vnf.ims.rst b/api/apidoc/functest.opnfv_tests.vnf.ims.rst
new file mode 100644 (file)
index 0000000..c6d1710
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.ims.rst
@@ -0,0 +1,38 @@
+functest.opnfv\_tests.vnf.ims package
+=====================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.vnf.ims.clearwater module
+-----------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.ims.clearwater
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.ims.cloudify\_ims module
+--------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.ims.cloudify_ims
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.ims.heat\_ims module
+----------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.ims.heat_ims
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf.ims
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.rst b/api/apidoc/functest.opnfv_tests.vnf.router.rst
new file mode 100644 (file)
index 0000000..4019243
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.router.rst
@@ -0,0 +1,46 @@
+functest.opnfv\_tests.vnf.router package
+========================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    functest.opnfv_tests.vnf.router.test_controller
+    functest.opnfv_tests.vnf.router.vnf_controller
+
+Submodules
+----------
+
+functest.opnfv\_tests.vnf.router.cloudify\_vrouter module
+---------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.cloudify_vrouter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.utilvnf module
+-----------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.utilvnf
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.vrouter\_base module
+-----------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vrouter_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf.router
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.rst b/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.rst
new file mode 100644 (file)
index 0000000..8de6ffc
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.rst
@@ -0,0 +1,22 @@
+functest.opnfv\_tests.vnf.router.test\_controller package
+=========================================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.vnf.router.test\_controller.function\_test\_exec module
+-----------------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.test_controller.function_test_exec
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.test_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.rst
new file mode 100644 (file)
index 0000000..1db20c6
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.rst
@@ -0,0 +1,54 @@
+functest.opnfv\_tests.vnf.router.vnf\_controller package
+========================================================
+
+Submodules
+----------
+
+functest.opnfv\_tests.vnf.router.vnf\_controller.checker module
+---------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.checker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.vnf\_controller.command\_generator module
+--------------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.command_generator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.vnf\_controller.ssh\_client module
+-------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.ssh_client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.vnf\_controller.vm\_controller module
+----------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.vm_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.opnfv\_tests.vnf.router.vnf\_controller.vnf\_controller module
+-----------------------------------------------------------------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.vnf_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.opnfv_tests.vnf.rst b/api/apidoc/functest.opnfv_tests.vnf.rst
new file mode 100644 (file)
index 0000000..07eb490
--- /dev/null
+++ b/api/apidoc/functest.opnfv_tests.vnf.rst
@@ -0,0 +1,19 @@
+functest.opnfv\_tests.vnf package
+=================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    functest.opnfv_tests.vnf.epc
+    functest.opnfv_tests.vnf.ims
+    functest.opnfv_tests.vnf.router
+
+Module contents
+---------------
+
+.. automodule:: functest.opnfv_tests.vnf
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.rst b/api/apidoc/functest.rst
index 63860f8..b308853 100644 (file)
--- a/api/apidoc/functest.rst
+++ b/api/apidoc/functest.rst
@@ -1,15 +1,20 @@
 functest package
 ================
 
-.. automodule:: functest
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 Subpackages
 -----------
 
 .. toctree::
 
+    functest.ci
     functest.core
     functest.opnfv_tests
+    functest.utils
+
+Module contents
+---------------
+
+.. automodule:: functest
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/api/apidoc/functest.utils.rst b/api/apidoc/functest.utils.rst
new file mode 100644 (file)
index 0000000..1070450
--- /dev/null
+++ b/api/apidoc/functest.utils.rst
@@ -0,0 +1,46 @@
+functest.utils package
+======================
+
+Submodules
+----------
+
+functest.utils.config module
+----------------------------
+
+.. automodule:: functest.utils.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.utils.constants module
+-------------------------------
+
+.. automodule:: functest.utils.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.utils.env module
+-------------------------
+
+.. automodule:: functest.utils.env
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+functest.utils.functest\_utils module
+-------------------------------------
+
+.. automodule:: functest.utils.functest_utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: functest.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

diff --git a/functest/ci/check_deployment.py b/functest/ci/check_deployment.py
index a475491..16c6934 100644 (file)
--- a/functest/ci/check_deployment.py
+++ b/functest/ci/check_deployment.py
@@ -7,10 +7,10 @@
 # which accompanies this distribution, and is available at
 # http://www.apache.org/licenses/LICENSE-2.0
 
-"""
-OpenStack deployment checker
+""" OpenStack deployment checker
 
 Verifies that:
+
  - Credentials file is given and contains the right information
  - OpenStack endpoints are reachable
 """

diff --git a/functest/core/tenantnetwork.py b/functest/core/tenantnetwork.py
index 760dc30..dbbb497 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
 

diff --git a/functest/utils/functest_utils.py b/functest/utils/functest_utils.py
index c5950c9..1993f1e 100644 (file)
--- a/functest/utils/functest_utils.py
+++ b/functest/utils/functest_utils.py
@@ -98,15 +98,13 @@ def get_nova_version(cloud):
 def get_openstack_version(cloud):
     """ Detect OpenStack version via Nova API microversion
 
-    It follows MicroversionHistory_.
+    It follows `MicroversionHistory
+    <https://docs.openstack.org/nova/latest/reference/api-microversion-history.html>`_.
 
     Returns:
 
     - OpenStack release
     - Unknown on operation error
-
-    .. _MicroversionHistory:
-    https://docs.openstack.org/nova/latest/reference/api-microversion-history.html
     """
     version = get_nova_version(cloud)
     try: