From: Thomas Bechtold Date: Mon, 20 Apr 2020 11:45:17 +0000 (+0200) Subject: docs: Add CLI help to docs X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=08f2ebc1aed3a57adfa3d0338e4f3a687597fa28;p=teuthology.git docs: Add CLI help to docs It's useful to have the command help available in the documentation. Signed-off-by: Thomas Bechtold (cherry picked from commit f999f592f1d81ea5b62da91a384984908d6fd754) --- diff --git a/docs/commands/list.rst b/docs/commands/list.rst new file mode 100644 index 000000000..0ac9437ea --- /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 index 000000000..6bc084165 --- /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 index 000000000..5123175f0 --- /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 index 000000000..856f561f7 --- /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 index 000000000..77ec0b89e --- /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 index 000000000..501fbfe80 --- /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 index 000000000..3f8c22283 --- /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 index 000000000..bdd3c49cc --- /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 index 000000000..22c3eee8f --- /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 index 000000000..3c03c3f57 --- /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 index 000000000..85c63eed7 --- /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 index 000000000..c0525aecc --- /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 index 000000000..c0096092c --- /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 index 000000000..0b7fdf2ab --- /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 b486160d2..5ac3609f9 100644 --- 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 fa1fa37d5..d871a5c11 100644 --- 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 9e899a668..eaaaf0602 100644 --- a/tox.ini +++ b/tox.ini @@ -66,6 +66,7 @@ changedir=docs deps= -r{toxinidir}/requirements2.txt sphinx + sphinxcontrib-programoutput mock==2.0.0 commands= sphinx-apidoc -f -o . ../teuthology ../teuthology/test ../teuthology/orchestra/test ../teuthology/task/test