diff options
| author |   Cédric Ollivier <cedric.ollivier@orange.com> | 2017-04-17 10:42:28 +0200 |
|---|---|---|
| committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2017-04-18 12:01:22 +0200 |
| commit | bebaf6e856aced93dd5b0498fedd160bf7bf8947 (patch) | |
| tree | d75b2be8f37355fbc94c73138ffb25d9418a6d8a /docs/api/apidoc/functest.core.rst | |
| parent | 55bc0f6446ed71a37282de6bd08fb1ee42152378 (diff) | |
Use Sphinx to create API documentation
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 <cedric.ollivier@orange.com>
Diffstat (limited to 'docs/api/apidoc/functest.core.rst')
| -rw-r--r-- | docs/api/apidoc/functest.core.rst | 17 |
1 files changed, 17 insertions, 0 deletions
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 + |