Add auto generated OSC documentation
This patch adds OpenStack client documentation that is auto generated using cliff. Change-Id: I7fb7414c268e6413ee7f21fccd7a045ba7f8418c
This commit is contained in:
parent
3648e2043e
commit
5b8068818d
47
doc/source/cli/index.rst
Normal file
47
doc/source/cli/index.rst
Normal file
@ -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 *
|
@ -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'
|
||||
|
@ -20,6 +20,7 @@ API in order to use the client.
|
||||
|
||||
install/index
|
||||
user/index
|
||||
cli/index
|
||||
contributor/index
|
||||
reference/index
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
==================================
|
||||
python-designateclient Reference
|
||||
==================================
|
||||
========================================
|
||||
python-designateclient Package Reference
|
||||
========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
Loading…
Reference in New Issue
Block a user