VOL-2678 Publish docs for cord-robot resources
Change-Id: Iaad08cb5b9be584d7d45fcee74db5aa972cc7777
diff --git a/Makefile b/Makefile
index d856041..56360b0 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,7 @@
# Other repos with documentation to include.
# edit the `git_refs` file with the commit/tag/branch that you want to use
-OTHER_REPO_DOCS ?= bbsim voltha-go voltha-openolt-adapter voltha-openonu-adapter voltha-protos voltctl voltha-system-tests
+OTHER_REPO_DOCS ?= bbsim voltha-go voltha-openolt-adapter voltha-openonu-adapter voltha-protos voltctl voltha-system-tests cord-tester
# Put it first so that "make" without argument is like "make help".
help: doc_venv
@@ -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*" ! -path "*repos/voltha-system-tests/vst_venv/*")
+ $$(find . -name \*.rst ! -path "*doc_venv*" ! -path "*vendor*" ! -path "*repos/voltha-system-tests/vst_venv/*" ! -path "*repos/cord-tester/venv_cord/*")
# markdown linting
# currently not enabled, should be added to lint target
@@ -55,7 +55,7 @@
# clean up
clean:
- rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS) _static/voltha-system-tests
+ rm -rf $(BUILDDIR) $(OTHER_REPO_DOCS) _static/voltha-system-tests _static/cord-tester
clean-all: clean
rm -rf doc_venv repos
@@ -96,6 +96,12 @@
mkdir -p $@
cp -r voltha-system-tests/gendocs/* $@
+# Build Robot documentation in cord-tester and copy it into _static.
+_static/cord-tester: | $(OTHER_REPO_DOCS)
+ make -C cord-tester gendocs
+ mkdir -p $@
+ cp -r cord-tester/gendocs/* $@
+
# generate a list of git checksums suitable for updating git_refs
freeze: repos
@for repo in $(OTHER_REPO_DOCS) ; do \
@@ -116,7 +122,7 @@
# building multiple versions
prep: | $(OTHER_REPO_DOCS)
-html: doc_venv Makefile | $(OTHER_REPO_DOCS) _static/voltha-system-tests
+html: doc_venv Makefile | $(OTHER_REPO_DOCS) _static/voltha-system-tests _static/cord-tester
source $</bin/activate ; set -u ;\
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/conf.py b/conf.py
index 177c948..04cb4b4 100644
--- a/conf.py
+++ b/conf.py
@@ -110,6 +110,11 @@
'_build',
'doc_venv',
'voltha-system-tests/vst_venv',
+ 'cord-tester/venv_cord',
+ 'cord-tester/docs',
+ 'cord-tester/src',
+ 'cord-tester/README.md',
+ 'cord-tester/cord-robot/README.rst',
'repos',
'requirements.txt',
'bbsim/README.md',
diff --git a/git_refs b/git_refs
index 8fa142d..b315a0e 100644
--- a/git_refs
+++ b/git_refs
@@ -13,6 +13,7 @@
pyvoltha / master
bbsim / master
+cord-tester / master
voltha-go / master
voltha-openolt-adapter / master
voltha-openonu-adapter / master
diff --git a/testing/index.rst b/testing/index.rst
index 232c41f..764a271 100644
--- a/testing/index.rst
+++ b/testing/index.rst
@@ -22,3 +22,26 @@
- `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>`_
+
+
+Package "cord-robot" Documentation
+==================================
+
+Below are links to the documentation generated by robot.libdoc for the Robot resources
+in the `cord-robot <https://pypi.org/project/cord-robot/>`_ Python pacakge.
+These files can also be generated locally by checking out the `cord-tester <https://github.com/opencord/cord-tester>`_
+repo and running **make gendocs**.
+
+Libraries
+---------
+- `ATTWorkflowDriver.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ATTWorkFlowDriver.html>`_
+- `DHCP.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/DHCP.html>`_
+- `Kubernetes.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Kubernetes.html>`_
+- `Network.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Network.html>`_
+- `OLT.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/OLT.html>`_
+- `ONOS.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ONOS.html>`_
+- `ONU.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/ONU.html>`_
+- `Subscriber.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/Subscriber.html>`_
+- `utils.resource <../_static/cord-tester/cord-robot/CORDRobot/rf-resources/utils.html>`_
+- `CORDDictUtils.py <../_static/cord-tester/cord-robot/CORDRobot/CORDDictUtils.html>`_
+- `testCaseUtils.py <../_static/cord-tester/cord-robot/CORDRobot/testCaseUtils.html>`_