Auto-generate robot library documentation

Change-Id: If4dc722282177f7174c12bdcc27411fc74b7ad42
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/.gitignore b/.gitignore
index 8e8d55bc0746675d2811de2fe12ee85b7e3d418f..d00b0df3c450229c2f840fe719de32ff38f46739 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,5 @@ target
 
 # Python
 .tox/
+__pycache__/
+*.pyc

diff --git a/docs/.gitignore b/docs/.gitignore
index 69fa449dd96e2405945b2e4cff2fd0ab8b102097..67d802da91456b4dd4d5da35b3eb7735db1ad7bb 100644 (file)
--- a/docs/.gitignore
+++ b/docs/.gitignore
@@ -1 +1,2 @@
 _build/
+_static/integration/robot

diff --git a/docs/build-integration-robot-libdoc.sh b/docs/build-integration-robot-libdoc.sh
new file mode 100755 (executable)
index 0000000..1cd5f6f
--- /dev/null
+++ b/docs/build-integration-robot-libdoc.sh
@@ -0,0 +1,9 @@
+#!/bin/bash
+
+ROBOT_DIR=`pwd`/_static/integration/robot
+
+mkdir -p $ROBOT_DIR
+cd submodules/integration/test/csit/libraries
+for f in *.robot; do python -m robot.libdoc $f $ROBOT_DIR/$f.html; done
+for f in *.py; do python -m robot.libdoc $f $ROBOT_DIR/$f.html; done
+

diff --git a/docs/conf.py b/docs/conf.py
index c11a826211fe4909c8ef22f350e1ab0a2df90d41..dee3bf1669a916851acafbc0ec86ca6d1bbb5531 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -295,3 +295,9 @@ linkcheck_ignore = [
     # The '#' in the path makes sphinx think it's an anchor
     'https://git.opendaylight.org/gerrit/#/admin/projects/releng/builder',
 ]
+
+# Build integration stuff
+import subprocess
+
+subprocess.call(["./build-integration-robot-libdoc.sh"])
+

diff --git a/requirements.txt b/requirements.txt
new file mode 100644 (file)
index 0000000..3aa4a8d
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,2 @@
+sphinx
+robotframework

diff --git a/tox.ini b/tox.ini
index 8ea4ee5b132235515b91bf8559d371dd9d33fefc..2223dec3241958292aad4b7880d7b2d611283806 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -4,9 +4,9 @@ envlist = docs,docs-linkcheck
 skipsdist = true
 
 [testenv:docs]
-deps = sphinx
+deps = -rrequirements.txt
 commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {envtmpdir}/html
 
 [testenv:docs-linkcheck]
-deps = sphinx
+deps = -rrequirements.txt
 commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {envtmpdir}/linkcheck