openstack/python-troveclient
Code Issues Proposed changes

Add cli to docs

Browse Source 
As part of phase 1, the cli reference should be moved to the local
repositories. "This content will move the project-specific client
documentation trees under doc/source/cli."[1]

I deleted the old reference and auto-generated the cli using the
tool here[2]

[1]http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html#what-is-happening-to-each-guide
[2]https://docs.openstack.org/contributor-guide/doc-tools/cli-reference.html

Change-Id: Ie1d5f2629021d738b8247c5335bce433ba5c4a05
This commit is contained in:
Trevor McCasland
2017-06-26 12:42:09 -05:00
parent 0d5c899edb
commit 5ff9b6183e
4 changed files with 2937 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@@ -16,11 +16,11 @@ This is a client for the OpenStack Trove API. There's a Python API (the
``troveclient`` module), and a command-line script (``trove``). Each ``troveclient`` module), and a command-line script (``trove``). Each
implements 100% of the OpenStack Trove API. implements 100% of the OpenStack Trove API.
See the `OpenStack CLI Guide`_ for information on how to use the ``trove`` See the `Trove CLI Guide`_ for information on how to use the ``trove``
command-line tool. You may also want to look at the command-line tool. You may also want to look at the
`OpenStack API documentation`_. `OpenStack API documentation`_.
.. _OpenStack CLI Guide: http://docs.openstack.org/user-guide/cli.html .. _Trove CLI Guide: http://docs.openstack.org/trove/latest/cli
.. _OpenStack API documentation: http://docs.openstack.org/api/quick-start/content/ .. _OpenStack API documentation: http://docs.openstack.org/api/quick-start/content/
python-troveclient is licensed under the Apache License like the rest of OpenStack. python-troveclient is licensed under the Apache License like the rest of OpenStack.

3
doc/source/cli/index.rst Normal file
View File

@@ -0,0 +1,3 @@
.. toctree::
trove.rst

2924
doc/source/cli/trove.rst Normal file
View File

File diff suppressed because it is too large Load Diff

11
doc/source/index.rst
View File

@@ -11,14 +11,19 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
.. include:: ../../README.rst ============================================
:start-line: 0 Python bindings to the OpenStack Trove API
:end-line: 22 ============================================
This is a client for the OpenStack Trove API. There's a Python API (the
``troveclient`` module), and a command-line script (``trove``). Each
implements 100% of the OpenStack Trove API.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
user/index user/index
cli/index
reference/index reference/index
Indices and tables Indices and tables