diff options
| author | Michael Johnson <johnsomor@gmail.com> | 2020-10-13 11:53:37 -0700 |
|---|---|---|
| committer | Michael Johnson <johnsomor@gmail.com> | 2020-10-13 11:54:42 -0700 |
| commit | 5b8068818dba6b20475aeb89fe02613f99978365 (patch) | |
| tree | 62a397d2c714f3acbb03be34d50bd61f199b6428 /doc | |
| parent | 3648e2043ec7c0f8adb05f4ffa8a6acf5157145a (diff) | |
| download | python-designateclient-5b8068818dba6b20475aeb89fe02613f99978365.tar.gz | |
Add auto generated OSC documentation
This patch adds OpenStack client documentation that is auto
generated using cliff.
Change-Id: I7fb7414c268e6413ee7f21fccd7a045ba7f8418c
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli/index.rst | 47 | ||||
| -rw-r--r-- | doc/source/conf.py | 3 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 6 |
4 files changed, 53 insertions, 4 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 0000000..d62ca4a --- /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 <command>``. + +======================== +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 2f483c0..31c3b65 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 a4aa7c3..668ad49 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 a2def4e..8a428b3 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 |