From 5b8068818dba6b20475aeb89fe02613f99978365 Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Tue, 13 Oct 2020 11:53:37 -0700 Subject: [PATCH] Add auto generated OSC documentation This patch adds OpenStack client documentation that is auto generated using cliff. Change-Id: I7fb7414c268e6413ee7f21fccd7a045ba7f8418c --- doc/source/cli/index.rst | 47 ++++++++++++++++++++++++++++++++++ doc/source/conf.py | 3 ++- doc/source/index.rst | 1 + doc/source/reference/index.rst | 6 ++--- 4 files changed, 53 insertions(+), 4 deletions(-) create mode 100644 doc/source/cli/index.rst diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 00000000..d62ca4a3 --- /dev/null +++ b/doc/source/cli/index.rst @@ -0,0 +1,47 @@ +Designate OpenStack Client Command Reference +============================================ + +List of released CLI commands available in OpenStack client. These commands +can be referenced by doing ``openstack help ``. + +======================== +Managing the DNS Service +======================== + +.. autoprogram-cliff:: openstack.dns.v2 + :command: dns * + +=============== +Pointer Records +=============== + +.. autoprogram-cliff:: openstack.dns.v2 + :command: ptr * + +=========== +Record Sets +=========== + +.. autoprogram-cliff:: openstack.dns.v2 + :command: recordset * + +================= +Top Level Domains +================= + +.. autoprogram-cliff:: openstack.dns.v2 + :command: tld * + +========================== +Transaction Signature Keys +========================== + +.. autoprogram-cliff:: openstack.dns.v2 + :command: tsigkey * + +============== +Managing Zones +============== + +.. autoprogram-cliff:: openstack.dns.v2 + :command: zone * diff --git a/doc/source/conf.py b/doc/source/conf.py index 2f483c05..31c3b653 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -10,7 +10,8 @@ extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinxcontrib.apidoc', - 'openstackdocstheme'] + 'openstackdocstheme', + 'cliff.sphinxext'] # openstackdocstheme options openstackdocs_repo_name = 'openstack/python-designateclient' diff --git a/doc/source/index.rst b/doc/source/index.rst index a4aa7c39..668ad496 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,6 +20,7 @@ API in order to use the client. install/index user/index + cli/index contributor/index reference/index diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index a2def4e1..8a428b3b 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -================================== - python-designateclient Reference -================================== +======================================== +python-designateclient Package Reference +======================================== .. toctree:: :maxdepth: 4