diff options
Diffstat (limited to 'api')
59 files changed, 584 insertions, 292 deletions
diff --git a/api/Makefile b/api/Makefile deleted file mode 100644 index ca9cfdc0b..000000000 --- a/api/Makefile +++ /dev/null @@ -1,225 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help -help: - @echo "Please use \`make <target>' where <target> is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " epub3 to make an epub3" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - @echo " dummy to check syntax errors of document sources" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OPNFVFunctest.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OPNFVFunctest.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/OPNFVFunctest" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OPNFVFunctest" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: epub3 -epub3: - $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 - @echo - @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." - -.PHONY: dummy -dummy: - $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy - @echo - @echo "Build finished. Dummy builder generates no files." diff --git a/api/_static/.gitkeep b/api/_static/.gitkeep deleted file mode 100644 index e69de29bb..000000000 --- a/api/_static/.gitkeep +++ /dev/null diff --git a/api/_templates/.gitkeep b/api/_templates/.gitkeep deleted file mode 100644 index e69de29bb..000000000 --- a/api/_templates/.gitkeep +++ /dev/null diff --git a/api/apidoc/functest.core.testcase.rst b/api/apidoc/functest.core.cloudify.rst index 2f947a1bf..aa186afe7 100644 --- a/api/apidoc/functest.core.testcase.rst +++ b/api/apidoc/functest.core.cloudify.rst @@ -1,7 +1,7 @@ -functest.core.testcase module +functest.core.cloudify module ============================= -.. automodule:: functest.core.testcase +.. automodule:: functest.core.cloudify :members: :undoc-members: :show-inheritance: diff --git a/api/apidoc/functest.core.robotframework.rst b/api/apidoc/functest.core.robotframework.rst deleted file mode 100644 index 5404912c5..000000000 --- a/api/apidoc/functest.core.robotframework.rst +++ /dev/null @@ -1,7 +0,0 @@ -functest.core.robotframework module -=================================== - -.. automodule:: functest.core.robotframework - :members: - :undoc-members: - :show-inheritance: diff --git a/api/apidoc/functest.core.rst b/api/apidoc/functest.core.rst index a610fa6fb..6d457c7f5 100644 --- a/api/apidoc/functest.core.rst +++ b/api/apidoc/functest.core.rst @@ -1,19 +1,19 @@ functest.core package ===================== -.. automodule:: functest.core - :members: - :undoc-members: - :show-inheritance: - Submodules ---------- .. toctree:: - functest.core.feature - functest.core.robotframework - functest.core.testcase - functest.core.vnf - functest.core.unit + functest.core.cloudify + functest.core.singlevm + functest.core.tenantnetwork +Module contents +--------------- + +.. automodule:: functest.core + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.core.singlevm.rst b/api/apidoc/functest.core.singlevm.rst new file mode 100644 index 000000000..171a3fae5 --- /dev/null +++ b/api/apidoc/functest.core.singlevm.rst @@ -0,0 +1,7 @@ +functest.core.singlevm module +============================= + +.. automodule:: functest.core.singlevm + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.core.tenantnetwork.rst b/api/apidoc/functest.core.tenantnetwork.rst new file mode 100644 index 000000000..db1dbf8a3 --- /dev/null +++ b/api/apidoc/functest.core.tenantnetwork.rst @@ -0,0 +1,7 @@ +functest.core.tenantnetwork module +================================== + +.. automodule:: functest.core.tenantnetwork + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.core.vnf.rst b/api/apidoc/functest.core.vnf.rst deleted file mode 100644 index 9fd6b375c..000000000 --- a/api/apidoc/functest.core.vnf.rst +++ /dev/null @@ -1,7 +0,0 @@ -functest.core.vnf module -======================== - -.. automodule:: functest.core.vnf - :members: - :undoc-members: - :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.api.connection_check.rst b/api/apidoc/functest.opnfv_tests.openstack.api.connection_check.rst new file mode 100644 index 000000000..62e9e87a9 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.api.connection_check.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.api.connection\_check module +============================================================ + +.. automodule:: functest.opnfv_tests.openstack.api.connection_check + :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 index 000000000..8f32cf8ee --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.api.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.api package +=========================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.api.connection_check + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.api + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.cinder.cinder_test.rst b/api/apidoc/functest.opnfv_tests.openstack.cinder.cinder_test.rst new file mode 100644 index 000000000..4f362cd22 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.cinder.cinder_test.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.cinder.cinder\_test module +========================================================== + +.. automodule:: functest.opnfv_tests.openstack.cinder.cinder_test + :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 index 000000000..58564dfc1 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.cinder.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.cinder package +============================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.cinder.cinder_test + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.cinder + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.patrole.patrole.rst b/api/apidoc/functest.opnfv_tests.openstack.patrole.patrole.rst new file mode 100644 index 000000000..6477fe7a2 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.patrole.patrole.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.patrole.patrole module +====================================================== + +.. automodule:: functest.opnfv_tests.openstack.patrole.patrole + :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 index 000000000..71138307b --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.patrole.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.patrole package +=============================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.patrole.patrole + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.patrole + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.rally.rally.rst b/api/apidoc/functest.opnfv_tests.openstack.rally.rally.rst new file mode 100644 index 000000000..480a5db46 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.rally.rally.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.rally.rally module +================================================== + +.. automodule:: functest.opnfv_tests.openstack.rally.rally + :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 index 000000000..b066607f5 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.rally.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.rally package +============================================= + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.rally.rally + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.rally + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.refstack.refstack.rst b/api/apidoc/functest.opnfv_tests.openstack.refstack.refstack.rst new file mode 100644 index 000000000..5e02e013c --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.refstack.refstack.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.refstack.refstack module +======================================================== + +.. automodule:: functest.opnfv_tests.openstack.refstack.refstack + :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 index 000000000..fbc4844de --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.refstack.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.refstack package +================================================ + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.refstack.refstack + +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 index 000000000..2a59e8818 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.rst @@ -0,0 +1,25 @@ +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.tempest + 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 index 000000000..ec347a952 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.shaker.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.shaker package +============================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.shaker.shaker + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.shaker + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.shaker.shaker.rst b/api/apidoc/functest.opnfv_tests.openstack.shaker.shaker.rst new file mode 100644 index 000000000..7035b816b --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.shaker.shaker.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.shaker.shaker module +==================================================== + +.. automodule:: functest.opnfv_tests.openstack.shaker.shaker + :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 index 000000000..e1a7a774a --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.tempest.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.tempest package +=============================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.tempest.tempest + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.tempest + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.tempest.tempest.rst b/api/apidoc/functest.opnfv_tests.openstack.tempest.tempest.rst new file mode 100644 index 000000000..ad60f3ee3 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.tempest.tempest.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.tempest.tempest module +====================================================== + +.. automodule:: functest.opnfv_tests.openstack.tempest.tempest + :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 index 000000000..50f558f45 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.vmtp.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.openstack.vmtp package +============================================ + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.vmtp.vmtp + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.vmtp + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.vmtp.vmtp.rst b/api/apidoc/functest.opnfv_tests.openstack.vmtp.vmtp.rst new file mode 100644 index 000000000..c6c53d86b --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.vmtp.vmtp.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.vmtp.vmtp module +================================================ + +.. automodule:: functest.opnfv_tests.openstack.vmtp.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 index 000000000..3b8983697 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.vping.rst @@ -0,0 +1,18 @@ +functest.opnfv\_tests.openstack.vping package +============================================= + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.openstack.vping.vping_ssh + functest.opnfv_tests.openstack.vping.vping_userdata + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.openstack.vping + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.vping.vping_ssh.rst b/api/apidoc/functest.opnfv_tests.openstack.vping.vping_ssh.rst new file mode 100644 index 000000000..192cbfb8f --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.vping.vping_ssh.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.vping.vping\_ssh module +======================================================= + +.. automodule:: functest.opnfv_tests.openstack.vping.vping_ssh + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.openstack.vping.vping_userdata.rst b/api/apidoc/functest.opnfv_tests.openstack.vping.vping_userdata.rst new file mode 100644 index 000000000..66a2f35d8 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.openstack.vping.vping_userdata.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.openstack.vping.vping\_userdata module +============================================================ + +.. automodule:: functest.opnfv_tests.openstack.vping.vping_userdata + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.rst b/api/apidoc/functest.opnfv_tests.rst index 52c2d4598..7d50b4db3 100644 --- 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 index e6f8c7367..caca46c67 100644 --- a/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst +++ b/api/apidoc/functest.opnfv_tests.sdn.odl.odl.rst @@ -1,5 +1,5 @@ -functest.opnfv_tests.sdn.odl.odl module -======================================= +functest.opnfv\_tests.sdn.odl.odl module +======================================== .. automodule:: functest.opnfv_tests.sdn.odl.odl :members: diff --git a/api/apidoc/functest.opnfv_tests.sdn.odl.rst b/api/apidoc/functest.opnfv_tests.sdn.odl.rst index 60659a1e3..3c1e85fcf 100644 --- a/api/apidoc/functest.opnfv_tests.sdn.odl.rst +++ b/api/apidoc/functest.opnfv_tests.sdn.odl.rst @@ -1,10 +1,5 @@ -functest.opnfv_tests.sdn.odl package -==================================== - -.. automodule:: functest.opnfv_tests.sdn.odl - :members: - :undoc-members: - :show-inheritance: +functest.opnfv\_tests.sdn.odl package +===================================== Submodules ---------- @@ -13,3 +8,10 @@ Submodules 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 ca8ae77da..cdec4291e 100644 --- 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.juju_epc.rst b/api/apidoc/functest.opnfv_tests.vnf.epc.juju_epc.rst new file mode 100644 index 000000000..59f4d586c --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.epc.juju_epc.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.epc.juju\_epc module +============================================== + +.. automodule:: functest.opnfv_tests.vnf.epc.juju_epc + :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 index 000000000..13f9886ef --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.epc.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.vnf.epc package +===================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.vnf.epc.juju_epc + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.vnf.epc + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.ims.clearwater.rst b/api/apidoc/functest.opnfv_tests.vnf.ims.clearwater.rst new file mode 100644 index 000000000..82ed81dbc --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.ims.clearwater.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.ims.clearwater module +=============================================== + +.. automodule:: functest.opnfv_tests.vnf.ims.clearwater + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.ims.cloudify_ims.rst b/api/apidoc/functest.opnfv_tests.vnf.ims.cloudify_ims.rst new file mode 100644 index 000000000..9c32d7d16 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.ims.cloudify_ims.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.ims.cloudify\_ims module +================================================== + +.. automodule:: functest.opnfv_tests.vnf.ims.cloudify_ims + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.ims.heat_ims.rst b/api/apidoc/functest.opnfv_tests.vnf.ims.heat_ims.rst new file mode 100644 index 000000000..21cdc46db --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.ims.heat_ims.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.ims.heat\_ims module +============================================== + +.. automodule:: functest.opnfv_tests.vnf.ims.heat_ims + :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 index 000000000..cce1944af --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.ims.rst @@ -0,0 +1,19 @@ +functest.opnfv\_tests.vnf.ims package +===================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.vnf.ims.clearwater + functest.opnfv_tests.vnf.ims.cloudify_ims + functest.opnfv_tests.vnf.ims.heat_ims + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.vnf.ims + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.cloudify_vrouter.rst b/api/apidoc/functest.opnfv_tests.vnf.router.cloudify_vrouter.rst new file mode 100644 index 000000000..2e265716e --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.cloudify_vrouter.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.router.cloudify\_vrouter module +========================================================= + +.. automodule:: functest.opnfv_tests.vnf.router.cloudify_vrouter + :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 index 000000000..de5ae5743 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.rst @@ -0,0 +1,27 @@ +functest.opnfv\_tests.vnf.router package +======================================== + +Subpackages +----------- + +.. toctree:: + + functest.opnfv_tests.vnf.router.test_controller + functest.opnfv_tests.vnf.router.vnf_controller + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.vnf.router.cloudify_vrouter + functest.opnfv_tests.vnf.router.utilvnf + functest.opnfv_tests.vnf.router.vrouter_base + +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.function_test_exec.rst b/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.function_test_exec.rst new file mode 100644 index 000000000..612314e21 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.function_test_exec.rst @@ -0,0 +1,7 @@ +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: 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 index 000000000..a3194e1dc --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.test_controller.rst @@ -0,0 +1,17 @@ +functest.opnfv\_tests.vnf.router.test\_controller package +========================================================= + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.vnf.router.test_controller.function_test_exec + +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.utilvnf.rst b/api/apidoc/functest.opnfv_tests.vnf.router.utilvnf.rst new file mode 100644 index 000000000..06571a085 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.utilvnf.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.router.utilvnf module +=============================================== + +.. automodule:: functest.opnfv_tests.vnf.router.utilvnf + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.checker.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.checker.rst new file mode 100644 index 000000000..6759dd7ec --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.checker.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.router.vnf\_controller.checker module +=============================================================== + +.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller.checker + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.command_generator.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.command_generator.rst new file mode 100644 index 000000000..869b34e65 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.command_generator.rst @@ -0,0 +1,7 @@ +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: 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 index 000000000..3f0ef5ac8 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.rst @@ -0,0 +1,21 @@ +functest.opnfv\_tests.vnf.router.vnf\_controller package +======================================================== + +Submodules +---------- + +.. toctree:: + + functest.opnfv_tests.vnf.router.vnf_controller.checker + functest.opnfv_tests.vnf.router.vnf_controller.command_generator + functest.opnfv_tests.vnf.router.vnf_controller.ssh_client + functest.opnfv_tests.vnf.router.vnf_controller.vm_controller + functest.opnfv_tests.vnf.router.vnf_controller.vnf_controller + +Module contents +--------------- + +.. automodule:: functest.opnfv_tests.vnf.router.vnf_controller + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.ssh_client.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.ssh_client.rst new file mode 100644 index 000000000..2f330a208 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.ssh_client.rst @@ -0,0 +1,7 @@ +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: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vm_controller.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vm_controller.rst new file mode 100644 index 000000000..d30b754a9 --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vm_controller.rst @@ -0,0 +1,7 @@ +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: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vnf_controller.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vnf_controller.rst new file mode 100644 index 000000000..8d799373f --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vnf_controller.vnf_controller.rst @@ -0,0 +1,7 @@ +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: diff --git a/api/apidoc/functest.opnfv_tests.vnf.router.vrouter_base.rst b/api/apidoc/functest.opnfv_tests.vnf.router.vrouter_base.rst new file mode 100644 index 000000000..eb766389e --- /dev/null +++ b/api/apidoc/functest.opnfv_tests.vnf.router.vrouter_base.rst @@ -0,0 +1,7 @@ +functest.opnfv\_tests.vnf.router.vrouter\_base module +===================================================== + +.. automodule:: functest.opnfv_tests.vnf.router.vrouter_base + :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 index 000000000..07eb49003 --- /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 63860f8f3..e6eb5189c 100644 --- 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,12 @@ Subpackages functest.core functest.opnfv_tests + functest.utils + +Module contents +--------------- + +.. automodule:: functest + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.core.feature.rst b/api/apidoc/functest.utils.config.rst index a80e38daa..5ea6e8982 100644 --- a/api/apidoc/functest.core.feature.rst +++ b/api/apidoc/functest.utils.config.rst @@ -1,7 +1,7 @@ -functest.core.feature module +functest.utils.config module ============================ -.. automodule:: functest.core.feature +.. automodule:: functest.utils.config :members: :undoc-members: :show-inheritance: diff --git a/api/apidoc/functest.utils.constants.rst b/api/apidoc/functest.utils.constants.rst new file mode 100644 index 000000000..b2c17a59f --- /dev/null +++ b/api/apidoc/functest.utils.constants.rst @@ -0,0 +1,7 @@ +functest.utils.constants module +=============================== + +.. automodule:: functest.utils.constants + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.core.unit.rst b/api/apidoc/functest.utils.env.rst index 5dd6880ed..cbcb3d6b0 100644 --- a/api/apidoc/functest.core.unit.rst +++ b/api/apidoc/functest.utils.env.rst @@ -1,7 +1,7 @@ -functest.core.unit module +functest.utils.env module ========================= -.. automodule:: functest.core.unit +.. automodule:: functest.utils.env :members: :undoc-members: :show-inheritance: diff --git a/api/apidoc/functest.utils.functest_utils.rst b/api/apidoc/functest.utils.functest_utils.rst new file mode 100644 index 000000000..73e33f34d --- /dev/null +++ b/api/apidoc/functest.utils.functest_utils.rst @@ -0,0 +1,7 @@ +functest.utils.functest\_utils module +===================================== + +.. automodule:: functest.utils.functest_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/api/apidoc/functest.utils.rst b/api/apidoc/functest.utils.rst new file mode 100644 index 000000000..716a11937 --- /dev/null +++ b/api/apidoc/functest.utils.rst @@ -0,0 +1,20 @@ +functest.utils package +====================== + +Submodules +---------- + +.. toctree:: + + functest.utils.config + functest.utils.constants + functest.utils.env + functest.utils.functest_utils + +Module contents +--------------- + +.. automodule:: functest.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/api/conf.py b/api/conf.py index 746a90fe0..18b33fdda 100644 --- a/api/conf.py +++ b/api/conf.py @@ -51,8 +51,8 @@ master_doc = 'index' # General information about the project. project = u'OPNFV Functest' -copyright = u'2017, #opnfv-functest (chat.freenode.net)' -author = u'#opnfv-functest (chat.freenode.net)' +copyright = u'2017, Functest <opnfv-tech-discuss@lists.opnfv.org>' +author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -121,7 +121,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -155,7 +155,7 @@ html_theme = 'alabaster' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied @@ -261,8 +261,11 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'OPNFVFunctest.tex', u'OPNFV Functest Documentation', - u'\\#opnfv-functest (chat.freenode.net)', 'manual'), + (master_doc, + 'OPNFVFunctest.tex', + u'OPNFV Functest Documentation', + u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}', + 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -303,7 +306,9 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'opnfvfunctest', u'OPNFV Functest Documentation', + (master_doc, + 'opnfvfunctest', + u'OPNFV Functest Documentation', [author], 1) ] @@ -318,8 +323,12 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'OPNFVFunctest', u'OPNFV Functest Documentation', - author, 'OPNFVFunctest', 'One line description of project.', + (master_doc, + 'OPNFVFunctest', + u'OPNFV Functest Documentation', + author, + 'OPNFVFunctest', + 'One line description of project.', 'Miscellaneous'), ] |