aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/doc_gen
diff options
context:
space:
mode:
authorTibor Frank <tifrank@cisco.com>2017-07-17 15:27:00 +0200
committerTibor Frank <tifrank@cisco.com>2017-07-18 08:59:19 +0200
commit997a1485635dd74aaf090ca5de608b6fdc25b74b (patch)
tree389a25dc4645bbeaac38a1b0997a181e1ec1ef73 /resources/tools/doc_gen
parentc76f8f80681c352b67fb714d65da25a5217c4ac8 (diff)
CSIT-723: Source code auto-generation for 1707
Change-Id: Ia178ac180fd344db620757dcc2b9cbb5010276c7 Signed-off-by: Tibor Frank <tifrank@cisco.com>
Diffstat (limited to 'resources/tools/doc_gen')
-rwxr-xr-xresources/tools/doc_gen/gen_rst.py3
-rw-r--r--resources/tools/doc_gen/src/index.rst7
-rw-r--r--resources/tools/doc_gen/src/requirements.txt2
-rw-r--r--resources/tools/doc_gen/src/tests.dpdk.perf.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.func.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.nsh_sfc.func.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.perf.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.tldk.func.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.func.ip4_tunnels.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.func.ip6_tunnels.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.func.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.func.vm_vhost.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.perf.ip4_tunnels.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.perf.ip6_tunnels.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.perf.rst3
-rw-r--r--resources/tools/doc_gen/src/tests.vpp.perf.vm_vhost.rst3
16 files changed, 41 insertions, 10 deletions
diff --git a/resources/tools/doc_gen/gen_rst.py b/resources/tools/doc_gen/gen_rst.py
index c79ffc07bb..898f215b1b 100755
--- a/resources/tools/doc_gen/gen_rst.py
+++ b/resources/tools/doc_gen/gen_rst.py
@@ -198,7 +198,8 @@ def generate_py_rst_files():
for file in files:
module_name = file.split('.')[0]
write_module_title(fh, module_name)
- fh.write(rst_py_module.format('.'.join(module_path), module_name))
+ fh.write(rst_py_module.format('.'.join(module_path),
+ module_name))
def generate_rf_rst_files(file_names, incl_tests=True, incl_keywords=True):
diff --git a/resources/tools/doc_gen/src/index.rst b/resources/tools/doc_gen/src/index.rst
index 77c6966150..6f44febb00 100644
--- a/resources/tools/doc_gen/src/index.rst
+++ b/resources/tools/doc_gen/src/index.rst
@@ -9,6 +9,9 @@ Contents
overview
resources.libraries.python
resources.libraries.robot
- tests.func
- tests.perf
+ tests.dpdk.perf
+ tests.nsh_sfc.func
+ tests.tldk.func
+ tests.vpp.func
+ tests.vpp.perf
indices
diff --git a/resources/tools/doc_gen/src/requirements.txt b/resources/tools/doc_gen/src/requirements.txt
index cf6b0e6df6..2cf7cd9687 100644
--- a/resources/tools/doc_gen/src/requirements.txt
+++ b/resources/tools/doc_gen/src/requirements.txt
@@ -1,3 +1,3 @@
-Sphinx
+Sphinx==1.5.5
sphinxcontrib_robotdoc
sphinx-rtd-theme \ No newline at end of file
diff --git a/resources/tools/doc_gen/src/tests.dpdk.perf.rst b/resources/tools/doc_gen/src/tests.dpdk.perf.rst
new file mode 100644
index 0000000000..a528a41924
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.dpdk.perf.rst
@@ -0,0 +1,3 @@
+DPDK Performance Tests
+======================
+
diff --git a/resources/tools/doc_gen/src/tests.func.rst b/resources/tools/doc_gen/src/tests.func.rst
deleted file mode 100644
index 74b26f175e..0000000000
--- a/resources/tools/doc_gen/src/tests.func.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-Functional Tests
-================
-
diff --git a/resources/tools/doc_gen/src/tests.nsh_sfc.func.rst b/resources/tools/doc_gen/src/tests.nsh_sfc.func.rst
new file mode 100644
index 0000000000..e06d26dc7c
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.nsh_sfc.func.rst
@@ -0,0 +1,3 @@
+NSH SFC Functional Tests
+========================
+
diff --git a/resources/tools/doc_gen/src/tests.perf.rst b/resources/tools/doc_gen/src/tests.perf.rst
deleted file mode 100644
index 226545ba84..0000000000
--- a/resources/tools/doc_gen/src/tests.perf.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-Performance Tests
-=================
-
diff --git a/resources/tools/doc_gen/src/tests.tldk.func.rst b/resources/tools/doc_gen/src/tests.tldk.func.rst
new file mode 100644
index 0000000000..85042fcf6c
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.tldk.func.rst
@@ -0,0 +1,3 @@
+TLDK Functional Tests
+=====================
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.func.ip4_tunnels.rst b/resources/tools/doc_gen/src/tests.vpp.func.ip4_tunnels.rst
new file mode 100644
index 0000000000..1c296e308f
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.func.ip4_tunnels.rst
@@ -0,0 +1,3 @@
+IPv4 Tunnels
+============
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.func.ip6_tunnels.rst b/resources/tools/doc_gen/src/tests.vpp.func.ip6_tunnels.rst
new file mode 100644
index 0000000000..40dbbc569b
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.func.ip6_tunnels.rst
@@ -0,0 +1,3 @@
+IPv6 Tunnels
+============
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.func.rst b/resources/tools/doc_gen/src/tests.vpp.func.rst
new file mode 100644
index 0000000000..c0e02ee2d0
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.func.rst
@@ -0,0 +1,3 @@
+VPP Functional Tests
+====================
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.func.vm_vhost.rst b/resources/tools/doc_gen/src/tests.vpp.func.vm_vhost.rst
new file mode 100644
index 0000000000..c669b232ea
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.func.vm_vhost.rst
@@ -0,0 +1,3 @@
+VM VHOST
+========
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.perf.ip4_tunnels.rst b/resources/tools/doc_gen/src/tests.vpp.perf.ip4_tunnels.rst
new file mode 100644
index 0000000000..1c296e308f
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.perf.ip4_tunnels.rst
@@ -0,0 +1,3 @@
+IPv4 Tunnels
+============
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.perf.ip6_tunnels.rst b/resources/tools/doc_gen/src/tests.vpp.perf.ip6_tunnels.rst
new file mode 100644
index 0000000000..40dbbc569b
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.perf.ip6_tunnels.rst
@@ -0,0 +1,3 @@
+IPv6 Tunnels
+============
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.perf.rst b/resources/tools/doc_gen/src/tests.vpp.perf.rst
new file mode 100644
index 0000000000..e349eafe8f
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.perf.rst
@@ -0,0 +1,3 @@
+VPP Performance Tests
+=====================
+
diff --git a/resources/tools/doc_gen/src/tests.vpp.perf.vm_vhost.rst b/resources/tools/doc_gen/src/tests.vpp.perf.vm_vhost.rst
new file mode 100644
index 0000000000..c669b232ea
--- /dev/null
+++ b/resources/tools/doc_gen/src/tests.vpp.perf.vm_vhost.rst
@@ -0,0 +1,3 @@
+VM VHOST
+========
+