From df87029775269d46d7c2d40396fa6083dc3d89c6 Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Mon, 20 Apr 2020 15:10:39 +0200 Subject: [PATCH] docs: Link commands to generated help This is useful to quickly show the available CLI help for the different commands. For that, auto generate labels based on the headline via a Sphinx extension. Signed-off-by: Thomas Bechtold --- docs/README.rst | 26 +++++++++++++------------- docs/conf.py | 1 + 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/README.rst b/docs/README.rst index e57a5a7f6..fa903b788 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -29,20 +29,20 @@ If you are new to teuthology and simply want to run existing tests, check out Provided Utilities ================== -* ``teuthology`` - Run individual jobs +* :ref:`teuthology` - Run individual jobs * ``teuthology-coverage`` - Analyze code coverage via lcov -* ``teuthology-kill`` - Kill running jobs or entire runs -* ``teuthology-lock`` - Lock, unlock, and update status of machines -* ``teuthology-ls`` - List job results by examining an archive directory -* ``teuthology-openstack`` - Use OpenStack backend (wrapper around ``teuthology-suite``) -* ``teuthology-nuke`` - Attempt to return a machine to a pristine state -* ``teuthology-queue`` - List, or delete, jobs in the queue -* ``teuthology-report`` - Submit test results to a web service (we use `paddles `__) -* ``teuthology-results`` - Examing a finished run and email results -* ``teuthology-schedule`` - Schedule a single job -* ``teuthology-suite`` - Schedule a full run based on a suite (see `suites` in `ceph-qa-suite `__) -* ``teuthology-updatekeys`` - Update SSH host keys for a machine -* ``teuthology-worker`` - Worker daemon to monitor the queue and execute jobs +* :ref:`teuthology-kill` - Kill running jobs or entire runs +* :ref:`teuthology-lock` - Lock, unlock, and update status of machines +* :ref:`teuthology-ls` - List job results by examining an archive directory +* :ref:`teuthology-openstack` - Use OpenStack backend (wrapper around ``teuthology-suite``) +* :ref:`teuthology-nuke` - Attempt to return a machine to a pristine state +* :ref:`teuthology-queue` - List, or delete, jobs in the queue +* :ref:`teuthology-report` - Submit test results to a web service (we use `paddles `__) +* :ref:`teuthology-results` - Examing a finished run and email results +* :ref:`teuthology-schedule` - Schedule a single job +* :ref:`teuthology-suite` - Schedule a full run based on a suite (see `suites` in `ceph-qa-suite `__) +* :ref:`teuthology-updatekeys` - Update SSH host keys for a machine +* :ref:`teuthology-worker` - Worker daemon to monitor the queue and execute jobs For a description of the distinct services that utilities interact with see :ref:`components`. diff --git a/docs/conf.py b/docs/conf.py index 5ac3609f9..09ae1e692 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ import os # ones. extensions = [ 'sphinx.ext.autodoc', + 'sphinx.ext.autosectionlabel', 'sphinxcontrib.programoutput', ] -- 2.47.3