docs: Add CLI help to docs

It's useful to have the command help available in the
documentation.

Signed-off-by: Thomas Bechtold <tbechtold@suse.com>

diff --git a/docs/commands/list.rst b/docs/commands/list.rst
new file mode 100644 (file)
index 0000000..0ac9437
--- /dev/null
+++ b/docs/commands/list.rst
@@ -0,0 +1,9 @@
+Command line interface (CLI)
+============================
+
+Help output of the available command line tools for teuthology.
+
+.. toctree::
+    :glob:
+
+    *

diff --git a/docs/commands/teuthology-kill.rst b/docs/commands/teuthology-kill.rst
new file mode 100644 (file)
index 0000000..6bc0841
--- /dev/null
+++ b/docs/commands/teuthology-kill.rst
@@ -0,0 +1,4 @@
+teuthology-kill
+===============
+
+.. program-output:: teuthology-kill --help

diff --git a/docs/commands/teuthology-lock.rst b/docs/commands/teuthology-lock.rst
new file mode 100644 (file)
index 0000000..5123175
--- /dev/null
+++ b/docs/commands/teuthology-lock.rst
@@ -0,0 +1,4 @@
+teuthology-lock
+===============
+
+.. program-output:: teuthology-lock --help

diff --git a/docs/commands/teuthology-ls.rst b/docs/commands/teuthology-ls.rst
new file mode 100644 (file)
index 0000000..856f561
--- /dev/null
+++ b/docs/commands/teuthology-ls.rst
@@ -0,0 +1,4 @@
+teuthology-ls
+=============
+
+.. program-output:: teuthology-ls --help

diff --git a/docs/commands/teuthology-nuke.rst b/docs/commands/teuthology-nuke.rst
new file mode 100644 (file)
index 0000000..77ec0b8
--- /dev/null
+++ b/docs/commands/teuthology-nuke.rst
@@ -0,0 +1,4 @@
+teuthology-nuke
+===============
+
+.. program-output:: teuthology-nuke --help

diff --git a/docs/commands/teuthology-openstack.rst b/docs/commands/teuthology-openstack.rst
new file mode 100644 (file)
index 0000000..501fbfe
--- /dev/null
+++ b/docs/commands/teuthology-openstack.rst
@@ -0,0 +1,4 @@
+teuthology-openstack
+====================
+
+.. program-output:: teuthology-openstack --help

diff --git a/docs/commands/teuthology-queue.rst b/docs/commands/teuthology-queue.rst
new file mode 100644 (file)
index 0000000..3f8c222
--- /dev/null
+++ b/docs/commands/teuthology-queue.rst
@@ -0,0 +1,4 @@
+teuthology-queue
+================
+
+.. program-output:: teuthology-queue --help

diff --git a/docs/commands/teuthology-report.rst b/docs/commands/teuthology-report.rst
new file mode 100644 (file)
index 0000000..bdd3c49
--- /dev/null
+++ b/docs/commands/teuthology-report.rst
@@ -0,0 +1,4 @@
+teuthology-report
+=================
+
+.. program-output:: teuthology-report --help

diff --git a/docs/commands/teuthology-results.rst b/docs/commands/teuthology-results.rst
new file mode 100644 (file)
index 0000000..22c3eee
--- /dev/null
+++ b/docs/commands/teuthology-results.rst
@@ -0,0 +1,4 @@
+teuthology-results
+==================
+
+.. program-output:: teuthology-results --help

diff --git a/docs/commands/teuthology-schedule.rst b/docs/commands/teuthology-schedule.rst
new file mode 100644 (file)
index 0000000..3c03c3f
--- /dev/null
+++ b/docs/commands/teuthology-schedule.rst
@@ -0,0 +1,4 @@
+teuthology-schedule
+===================
+
+.. program-output:: teuthology-schedule --help

diff --git a/docs/commands/teuthology-suite.rst b/docs/commands/teuthology-suite.rst
new file mode 100644 (file)
index 0000000..85c63ee
--- /dev/null
+++ b/docs/commands/teuthology-suite.rst
@@ -0,0 +1,4 @@
+teuthology-suite
+================
+
+.. program-output:: teuthology-suite --help

diff --git a/docs/commands/teuthology-updatekeys.rst b/docs/commands/teuthology-updatekeys.rst
new file mode 100644 (file)
index 0000000..c0525ae
--- /dev/null
+++ b/docs/commands/teuthology-updatekeys.rst
@@ -0,0 +1,4 @@
+teuthology-updatekeys
+=====================
+
+.. program-output:: teuthology-updatekeys --help

diff --git a/docs/commands/teuthology-worker.rst b/docs/commands/teuthology-worker.rst
new file mode 100644 (file)
index 0000000..c009609
--- /dev/null
+++ b/docs/commands/teuthology-worker.rst
@@ -0,0 +1,4 @@
+teuthology-worker
+=================
+
+.. program-output:: teuthology-worker --help

diff --git a/docs/commands/teuthology.rst b/docs/commands/teuthology.rst
new file mode 100644 (file)
index 0000000..0b7fdf2
--- /dev/null
+++ b/docs/commands/teuthology.rst
@@ -0,0 +1,4 @@
+teuthology
+==========
+
+.. program-output:: teuthology --help

diff --git a/docs/conf.py b/docs/conf.py
index b486160d2b3707afb536687fcf03356849b40642..5ac3609f9a7eea5a9fedec2d74c5e49cfff93942 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -30,6 +30,7 @@ import os
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinxcontrib.programoutput',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
index fa1fa37d56ce27e6851cfe3b24552201ed63b1fc..d871a5c11bb267984b5abfe59054feb94648c724 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,6 +13,7 @@ Content Index
    downburst_vms.rst
    INSTALL.rst
    LAB_SETUP.rst
+   commands/list.rst
    ChangeLog.rst
 
 Indices and tables

diff --git a/tox.ini b/tox.ini
index 11449d79216020e89bef9b0ad67bad796b2978cc..6fbb040b9f35d3b104de5def52e6342465e38ed7 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -66,6 +66,7 @@ changedir=docs
 deps=
   -r{toxinidir}/requirements3.txt
   sphinx
+  sphinxcontrib-programoutput
   mock==2.0.0
 commands=
     sphinx-apidoc -f -o . ../teuthology ../teuthology/test ../teuthology/orchestra/test ../teuthology/task/test