Publish generated voltha-system-tests docs
Change-Id: If5b2d2892cb22255141692939e4e3d8ca691d33a
diff --git a/Makefile b/Makefile
index 6e24ffc..f444987 100644
--- a/Makefile
+++ b/Makefile
@@ -40,7 +40,7 @@
doc8: doc_venv | $(OTHER_REPO_DOCS)
source $</bin/activate ; set -u ;\
doc8 --max-line-length 119 \
- $$(find . -name \*.rst ! -path "*doc_venv*" ! -path "*vendor*")
+ $$(find . -name \*.rst ! -path "*doc_venv*" ! -path "*vendor*" ! -path "*repos/voltha-system-tests/vst_venv/*")
# markdown linting
# currently not enabled, should be added to lint target
@@ -55,7 +55,7 @@
# clean up
clean:
- rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS)
+ rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS) repos/voltha-system-tests _static/voltha-system-tests
clean-all: clean
rm -rf doc_venv repos
@@ -110,9 +110,22 @@
# building multiple versions
prep: | $(OTHER_REPO_DOCS)
+html: doc_venv Makefile | $(OTHER_REPO_DOCS) _static/voltha-system-tests
+ source $</bin/activate ; set -u ;\
+ $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: doc_venv Makefile | $(OTHER_REPO_DOCS)
source $</bin/activate ; set -u ;\
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+repos/voltha-system-tests: | repos
+ if [ ! -d '$@' ] ;\
+ then git clone $(REPO_HOST)/$(@F) $@ ;\
+ fi
+
+_static/voltha-system-tests: repos/voltha-system-tests
+ make -C $< gendocs
+ mkdir -p $@
+ cp -r $</gendocs/* $@
diff --git a/index.rst b/index.rst
index b22db7e..288e0fb 100644
--- a/index.rst
+++ b/index.rst
@@ -34,6 +34,12 @@
.. toctree::
:maxdepth: 1
+ :caption: Testing
+
+ testing/index.rst
+
+.. toctree::
+ :maxdepth: 1
:caption: VOLTHA Core (outdated)
voltha-go/README.md
diff --git a/testing/index.rst b/testing/index.rst
new file mode 100644
index 0000000..232c41f
--- /dev/null
+++ b/testing/index.rst
@@ -0,0 +1,24 @@
+VOLTHA System Tests Documentation
+=================================
+
+Below are links to the documentation generated by robot.libdoc from the Robot resources
+in the `voltha-system-tests <https://github.com/opencord/voltha-system-tests>`_ repository.
+These files can also be generated locally by checking out the repo and running **make gendocs**.
+
+Libraries
+---------
+- `libraries/k8s.robot <../_static/voltha-system-tests/libraries/k8s.html>`_
+- `libraries/onos.robot <../_static/voltha-system-tests/libraries/onos.html>`_
+- `libraries/power_switch.robot <../_static/voltha-system-tests/libraries/power_switch.html>`_
+- `libraries/utils.robot <../_static/voltha-system-tests/libraries/utils.html>`_
+- `libraries/voltctl.robot <../_static/voltha-system-tests/libraries/voltctl.html>`_
+- `libraries/voltha.robot <../_static/voltha-system-tests/libraries/voltha.html>`_
+
+
+Test Files
+----------
+- `tests/functional/K8S_SystemTest.robot <../_static/voltha-system-tests/tests/functional/K8S_SystemTest.html>`_
+- `tests/functional/Voltha_ErrorScenarios.robot <../_static/voltha-system-tests/tests/functional/Voltha_ErrorScenarios.html>`_
+- `tests/functional/Voltha_FailureScenarios.robot <../_static/voltha-system-tests/tests/functional/Voltha_FailureScenarios.html>`_
+- `tests/functional/Voltha_PODTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_PODTests.html>`_
+- `tests/functional/Voltha_ScaleFunctionalTests.robot <../_static/voltha-system-tests/tests/functional/Voltha_ScaleFunctionalTests.html>`_