From bebaf6e856aced93dd5b0498fedd160bf7bf8947 Mon Sep 17 00:00:00 2001 From: Cédric Ollivier Date: Mon, 17 Apr 2017 10:42:28 +0200 Subject: Use Sphinx to create API documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The packages/modules which are part of Functest framework are parsed. It also generates ODL TestCase API as it's well commented. The content is simply referring to modules. Change-Id: I873ae1535fc05c9d7e426f5fb54f9579eb01e6d1 Signed-off-by: Cédric Ollivier --- docs/api/apidoc/functest.core.feature.rst | 7 +++++++ docs/api/apidoc/functest.core.rst | 17 +++++++++++++++++ docs/api/apidoc/functest.core.testcase.rst | 7 +++++++ docs/api/apidoc/functest.core.vnf_base.rst | 7 +++++++ docs/api/apidoc/functest.opnfv_tests.rst | 14 ++++++++++++++ docs/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst | 7 +++++++ docs/api/apidoc/functest.opnfv_tests.sdn.odl.rst | 15 +++++++++++++++ docs/api/apidoc/functest.opnfv_tests.sdn.rst | 14 ++++++++++++++ docs/api/apidoc/functest.rst | 15 +++++++++++++++ docs/api/apidoc/modules.rst | 7 +++++++ 10 files changed, 110 insertions(+) create mode 100644 docs/api/apidoc/functest.core.feature.rst create mode 100644 docs/api/apidoc/functest.core.rst create mode 100644 docs/api/apidoc/functest.core.testcase.rst create mode 100644 docs/api/apidoc/functest.core.vnf_base.rst create mode 100644 docs/api/apidoc/functest.opnfv_tests.rst create mode 100644 docs/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst create mode 100644 docs/api/apidoc/functest.opnfv_tests.sdn.odl.rst create mode 100644 docs/api/apidoc/functest.opnfv_tests.sdn.rst create mode 100644 docs/api/apidoc/functest.rst create mode 100644 docs/api/apidoc/modules.rst (limited to 'docs/api/apidoc') diff --git a/docs/api/apidoc/functest.core.feature.rst b/docs/api/apidoc/functest.core.feature.rst new file mode 100644 index 000000000..a80e38daa --- /dev/null +++ b/docs/api/apidoc/functest.core.feature.rst @@ -0,0 +1,7 @@ +functest.core.feature module +============================ + +.. automodule:: functest.core.feature + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/apidoc/functest.core.rst b/docs/api/apidoc/functest.core.rst new file mode 100644 index 000000000..29c67e4e3 --- /dev/null +++ b/docs/api/apidoc/functest.core.rst @@ -0,0 +1,17 @@ +functest.core package +===================== + +.. automodule:: functest.core + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + functest.core.feature + functest.core.testcase + functest.core.vnf_base + diff --git a/docs/api/apidoc/functest.core.testcase.rst b/docs/api/apidoc/functest.core.testcase.rst new file mode 100644 index 000000000..2f947a1bf --- /dev/null +++ b/docs/api/apidoc/functest.core.testcase.rst @@ -0,0 +1,7 @@ +functest.core.testcase module +============================= + +.. automodule:: functest.core.testcase + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/apidoc/functest.core.vnf_base.rst b/docs/api/apidoc/functest.core.vnf_base.rst new file mode 100644 index 000000000..94b2eaa90 --- /dev/null +++ b/docs/api/apidoc/functest.core.vnf_base.rst @@ -0,0 +1,7 @@ +functest.core.vnf_base module +============================= + +.. automodule:: functest.core.vnf_base + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/apidoc/functest.opnfv_tests.rst b/docs/api/apidoc/functest.opnfv_tests.rst new file mode 100644 index 000000000..52c2d4598 --- /dev/null +++ b/docs/api/apidoc/functest.opnfv_tests.rst @@ -0,0 +1,14 @@ +functest.opnfv_tests package +============================ + +.. automodule:: functest.opnfv_tests + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + functest.opnfv_tests.sdn diff --git a/docs/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst b/docs/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst new file mode 100644 index 000000000..e6f8c7367 --- /dev/null +++ b/docs/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst @@ -0,0 +1,7 @@ +functest.opnfv_tests.sdn.odl.odl module +======================================= + +.. automodule:: functest.opnfv_tests.sdn.odl.odl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/apidoc/functest.opnfv_tests.sdn.odl.rst b/docs/api/apidoc/functest.opnfv_tests.sdn.odl.rst new file mode 100644 index 000000000..60659a1e3 --- /dev/null +++ b/docs/api/apidoc/functest.opnfv_tests.sdn.odl.rst @@ -0,0 +1,15 @@ +functest.opnfv_tests.sdn.odl package +==================================== + +.. automodule:: functest.opnfv_tests.sdn.odl + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.sdn.odl.odl + diff --git a/docs/api/apidoc/functest.opnfv_tests.sdn.rst b/docs/api/apidoc/functest.opnfv_tests.sdn.rst new file mode 100644 index 000000000..ca8ae77da --- /dev/null +++ b/docs/api/apidoc/functest.opnfv_tests.sdn.rst @@ -0,0 +1,14 @@ +functest.opnfv_tests.sdn package +================================ + +.. automodule:: functest.opnfv_tests.sdn + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + functest.opnfv_tests.sdn.odl diff --git a/docs/api/apidoc/functest.rst b/docs/api/apidoc/functest.rst new file mode 100644 index 000000000..63860f8f3 --- /dev/null +++ b/docs/api/apidoc/functest.rst @@ -0,0 +1,15 @@ +functest package +================ + +.. automodule:: functest + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + + functest.core + functest.opnfv_tests diff --git a/docs/api/apidoc/modules.rst b/docs/api/apidoc/modules.rst new file mode 100644 index 000000000..b8f33304a --- /dev/null +++ b/docs/api/apidoc/modules.rst @@ -0,0 +1,7 @@ +functest +======== + +.. toctree:: + :maxdepth: 4 + + functest -- cgit 1.2.3-korg