aboutsummaryrefslogtreecommitdiffstats
path: root/api
diff options
context:
space:
mode:
Diffstat (limited to 'api')
-rw-r--r--api/Makefile8
-rw-r--r--api/apidoc/functest.core.feature.rst7
-rw-r--r--api/apidoc/functest.core.robotframework.rst7
-rw-r--r--api/apidoc/functest.core.rst19
-rw-r--r--api/apidoc/functest.core.testcase.rst7
-rw-r--r--api/apidoc/functest.core.unit.rst7
-rw-r--r--api/apidoc/functest.core.vnf.rst7
-rw-r--r--api/apidoc/functest.rst14
-rw-r--r--api/apidoc/modules.rst4
-rw-r--r--api/apidoc/xtesting.ci.rst17
-rw-r--r--api/apidoc/xtesting.ci.run_tests.rst7
-rw-r--r--api/apidoc/xtesting.ci.tier_builder.rst7
-rw-r--r--api/apidoc/xtesting.ci.tier_handler.rst7
-rw-r--r--api/apidoc/xtesting.core.feature.rst7
-rw-r--r--api/apidoc/xtesting.core.robotframework.rst7
-rw-r--r--api/apidoc/xtesting.core.rst19
-rw-r--r--api/apidoc/xtesting.core.testcase.rst7
-rw-r--r--api/apidoc/xtesting.core.unit.rst7
-rw-r--r--api/apidoc/xtesting.core.vnf.rst7
-rw-r--r--api/apidoc/xtesting.energy.energy.rst7
-rw-r--r--api/apidoc/xtesting.energy.rst15
-rw-r--r--api/apidoc/xtesting.rst18
-rw-r--r--api/apidoc/xtesting.utils.constants.rst7
-rw-r--r--api/apidoc/xtesting.utils.decorators.rst7
-rw-r--r--api/apidoc/xtesting.utils.env.rst7
-rw-r--r--api/apidoc/xtesting.utils.rst17
-rw-r--r--api/conf.py16
-rw-r--r--api/index.rst4
28 files changed, 186 insertions, 84 deletions
diff --git a/api/Makefile b/api/Makefile
index ca9cfdc0..ba974605 100644
--- a/api/Makefile
+++ b/api/Makefile
@@ -91,9 +91,9 @@ 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 "# qcollectiongenerator $(BUILDDIR)/qthelp/Xtesting.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OPNFVFunctest.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Xtesting.qhc"
.PHONY: applehelp
applehelp:
@@ -110,8 +110,8 @@ 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 "# mkdir -p $$HOME/.local/share/devhelp/Xtesting"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Xtesting"
@echo "# devhelp"
.PHONY: epub
diff --git a/api/apidoc/functest.core.feature.rst b/api/apidoc/functest.core.feature.rst
deleted file mode 100644
index a80e38da..00000000
--- a/api/apidoc/functest.core.feature.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-functest.core.feature module
-============================
-
-.. automodule:: functest.core.feature
- :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 5404912c..00000000
--- 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
deleted file mode 100644
index a610fa6f..00000000
--- a/api/apidoc/functest.core.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-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
-
diff --git a/api/apidoc/functest.core.testcase.rst b/api/apidoc/functest.core.testcase.rst
deleted file mode 100644
index 2f947a1b..00000000
--- a/api/apidoc/functest.core.testcase.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-functest.core.testcase module
-=============================
-
-.. automodule:: functest.core.testcase
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/api/apidoc/functest.core.unit.rst b/api/apidoc/functest.core.unit.rst
deleted file mode 100644
index 5dd6880e..00000000
--- a/api/apidoc/functest.core.unit.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-functest.core.unit module
-=========================
-
-.. automodule:: functest.core.unit
- :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 9fd6b375..00000000
--- 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.rst b/api/apidoc/functest.rst
deleted file mode 100644
index 0fb6e791..00000000
--- a/api/apidoc/functest.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-functest package
-================
-
-.. automodule:: functest
- :members:
- :undoc-members:
- :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-
- functest.core
diff --git a/api/apidoc/modules.rst b/api/apidoc/modules.rst
index b8f33304..c23e273e 100644
--- a/api/apidoc/modules.rst
+++ b/api/apidoc/modules.rst
@@ -1,7 +1,7 @@
-functest
+xtesting
========
.. toctree::
:maxdepth: 4
- functest
+ xtesting
diff --git a/api/apidoc/xtesting.ci.rst b/api/apidoc/xtesting.ci.rst
new file mode 100644
index 00000000..8bbe7b7e
--- /dev/null
+++ b/api/apidoc/xtesting.ci.rst
@@ -0,0 +1,17 @@
+xtesting\.ci package
+====================
+
+.. automodule:: xtesting.ci
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ xtesting.ci.run_tests
+ xtesting.ci.tier_builder
+ xtesting.ci.tier_handler
+
diff --git a/api/apidoc/xtesting.ci.run_tests.rst b/api/apidoc/xtesting.ci.run_tests.rst
new file mode 100644
index 00000000..b3782578
--- /dev/null
+++ b/api/apidoc/xtesting.ci.run_tests.rst
@@ -0,0 +1,7 @@
+xtesting\.ci\.run\_tests module
+===============================
+
+.. automodule:: xtesting.ci.run_tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.ci.tier_builder.rst b/api/apidoc/xtesting.ci.tier_builder.rst
new file mode 100644
index 00000000..fd31c87b
--- /dev/null
+++ b/api/apidoc/xtesting.ci.tier_builder.rst
@@ -0,0 +1,7 @@
+xtesting\.ci\.tier\_builder module
+==================================
+
+.. automodule:: xtesting.ci.tier_builder
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.ci.tier_handler.rst b/api/apidoc/xtesting.ci.tier_handler.rst
new file mode 100644
index 00000000..9a6e7255
--- /dev/null
+++ b/api/apidoc/xtesting.ci.tier_handler.rst
@@ -0,0 +1,7 @@
+xtesting\.ci\.tier\_handler module
+==================================
+
+.. automodule:: xtesting.ci.tier_handler
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.core.feature.rst b/api/apidoc/xtesting.core.feature.rst
new file mode 100644
index 00000000..635951f3
--- /dev/null
+++ b/api/apidoc/xtesting.core.feature.rst
@@ -0,0 +1,7 @@
+xtesting\.core\.feature module
+==============================
+
+.. automodule:: xtesting.core.feature
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.core.robotframework.rst b/api/apidoc/xtesting.core.robotframework.rst
new file mode 100644
index 00000000..0838f8ef
--- /dev/null
+++ b/api/apidoc/xtesting.core.robotframework.rst
@@ -0,0 +1,7 @@
+xtesting\.core\.robotframework module
+=====================================
+
+.. automodule:: xtesting.core.robotframework
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.core.rst b/api/apidoc/xtesting.core.rst
new file mode 100644
index 00000000..ca38ef39
--- /dev/null
+++ b/api/apidoc/xtesting.core.rst
@@ -0,0 +1,19 @@
+xtesting\.core package
+======================
+
+.. automodule:: xtesting.core
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ xtesting.core.feature
+ xtesting.core.robotframework
+ xtesting.core.testcase
+ xtesting.core.unit
+ xtesting.core.vnf
+
diff --git a/api/apidoc/xtesting.core.testcase.rst b/api/apidoc/xtesting.core.testcase.rst
new file mode 100644
index 00000000..b572faa0
--- /dev/null
+++ b/api/apidoc/xtesting.core.testcase.rst
@@ -0,0 +1,7 @@
+xtesting\.core\.testcase module
+===============================
+
+.. automodule:: xtesting.core.testcase
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.core.unit.rst b/api/apidoc/xtesting.core.unit.rst
new file mode 100644
index 00000000..ff0e5322
--- /dev/null
+++ b/api/apidoc/xtesting.core.unit.rst
@@ -0,0 +1,7 @@
+xtesting\.core\.unit module
+===========================
+
+.. automodule:: xtesting.core.unit
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.core.vnf.rst b/api/apidoc/xtesting.core.vnf.rst
new file mode 100644
index 00000000..a5450b4a
--- /dev/null
+++ b/api/apidoc/xtesting.core.vnf.rst
@@ -0,0 +1,7 @@
+xtesting\.core\.vnf module
+==========================
+
+.. automodule:: xtesting.core.vnf
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.energy.energy.rst b/api/apidoc/xtesting.energy.energy.rst
new file mode 100644
index 00000000..05e42381
--- /dev/null
+++ b/api/apidoc/xtesting.energy.energy.rst
@@ -0,0 +1,7 @@
+xtesting\.energy\.energy module
+===============================
+
+.. automodule:: xtesting.energy.energy
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.energy.rst b/api/apidoc/xtesting.energy.rst
new file mode 100644
index 00000000..efd6ed16
--- /dev/null
+++ b/api/apidoc/xtesting.energy.rst
@@ -0,0 +1,15 @@
+xtesting\.energy package
+========================
+
+.. automodule:: xtesting.energy
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ xtesting.energy.energy
+
diff --git a/api/apidoc/xtesting.rst b/api/apidoc/xtesting.rst
new file mode 100644
index 00000000..7f7ee676
--- /dev/null
+++ b/api/apidoc/xtesting.rst
@@ -0,0 +1,18 @@
+xtesting package
+================
+
+.. automodule:: xtesting
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+ xtesting.ci
+ xtesting.core
+ xtesting.energy
+ xtesting.utils
+
diff --git a/api/apidoc/xtesting.utils.constants.rst b/api/apidoc/xtesting.utils.constants.rst
new file mode 100644
index 00000000..7036ae7d
--- /dev/null
+++ b/api/apidoc/xtesting.utils.constants.rst
@@ -0,0 +1,7 @@
+xtesting\.utils\.constants module
+=================================
+
+.. automodule:: xtesting.utils.constants
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.utils.decorators.rst b/api/apidoc/xtesting.utils.decorators.rst
new file mode 100644
index 00000000..455ca69e
--- /dev/null
+++ b/api/apidoc/xtesting.utils.decorators.rst
@@ -0,0 +1,7 @@
+xtesting\.utils\.decorators module
+==================================
+
+.. automodule:: xtesting.utils.decorators
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.utils.env.rst b/api/apidoc/xtesting.utils.env.rst
new file mode 100644
index 00000000..8629ad65
--- /dev/null
+++ b/api/apidoc/xtesting.utils.env.rst
@@ -0,0 +1,7 @@
+xtesting\.utils\.env module
+===========================
+
+.. automodule:: xtesting.utils.env
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/api/apidoc/xtesting.utils.rst b/api/apidoc/xtesting.utils.rst
new file mode 100644
index 00000000..b4478c9e
--- /dev/null
+++ b/api/apidoc/xtesting.utils.rst
@@ -0,0 +1,17 @@
+xtesting\.utils package
+=======================
+
+.. automodule:: xtesting.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+ xtesting.utils.constants
+ xtesting.utils.decorators
+ xtesting.utils.env
+
diff --git a/api/conf.py b/api/conf.py
index b5adb4ca..e197623d 100644
--- a/api/conf.py
+++ b/api/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# OPNFV Functest documentation build configuration file, created by
+# Xtesting documentation build configuration file, created by
# sphinx-quickstart on Mon Apr 17 10:03:43 2017.
#
# This file is execfile()d with the current directory set to its
@@ -50,7 +50,7 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = u'OPNFV Functest'
+project = u'Xtesting'
copyright = u'2017, #opnfv-functest (chat.freenode.net)'
author = u'#opnfv-functest (chat.freenode.net)'
@@ -135,7 +135,7 @@ html_theme = 'sphinx_rtd_theme'
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
-# html_title = u'OPNFV Functest vmaster'
+# html_title = u'Xtesting vmaster'
# A shorter title for the navigation bar. Default is the same as html_title.
#
@@ -235,7 +235,7 @@ html_static_path = ['_static']
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
-htmlhelp_basename = 'OPNFVFunctestdoc'
+htmlhelp_basename = 'Xtestingdoc'
# -- Options for LaTeX output ---------------------------------------------
@@ -261,7 +261,7 @@ 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',
+ (master_doc, 'Xtesting.tex', u'Xtesting Documentation',
u'\\#opnfv-functest (chat.freenode.net)', 'manual'),
]
@@ -303,7 +303,7 @@ 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, 'xtesting', u'Xtesting Documentation',
[author], 1)
]
@@ -318,8 +318,8 @@ 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, 'Xtesting', u'Xtesting Documentation',
+ author, 'Xtesting', 'One line description of project.',
'Miscellaneous'),
]
diff --git a/api/index.rst b/api/index.rst
index db223437..cc961041 100644
--- a/api/index.rst
+++ b/api/index.rst
@@ -1,5 +1,5 @@
-Welcome to OPNFV Functest's documentation!
-==========================================
+Welcome to Xtesting's documentation!
+====================================
Contents: