Merge "Add cli to docs"

This commit is contained in:
Jenkins 2017-07-16 14:23:38 +00:00 committed by Gerrit Code Review
commit 348822b8a5
4 changed files with 2937 additions and 5 deletions

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
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
`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/
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

File diff suppressed because it is too large Load Diff

View File

@ -11,14 +11,19 @@
License for the specific language governing permissions and limitations
under the License.
.. include:: ../../README.rst
:start-line: 0
:end-line: 22
============================================
Python bindings to the OpenStack Trove API
============================================
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::
:maxdepth: 2
user/index
cli/index
reference/index
Indices and tables