openstack
/
python-octaviaclient
Code Issues Proposed changes

Update Docs for more information and dummy commands 

To use for reference and to improve organization of the client docs

Change-Id: I44d17935982171897a78f307595957585277d91f
This commit is contained in:
Ankur Gupta 2017-03-30 12:34:14 -05:00
parent d3096c57c9
commit 6c069463b7
3 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/index.rst
View File

@ -3,28 +3,35 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to python-octaviaclient's documentation!
========================================================
Python Octavia Client
=====================
Contents:
The Python Octavia Client (python-octaviaclient) is a command-line client for
the OpenStack Load Balancing service.
Getting Started
---------------
.. toctree::
:maxdepth: 2
readme
installation
usage
usage/osc_cli_plugins
contributing
Usage
-----
.. toctree::
:maxdepth: 2
usage/osc_cli_plugins
decoder
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

7
doc/source/usage.rst
View File

@ -1,7 +0,0 @@
========
Usage
========
To use python-octaviaclient in a project::
import octaviaclient

11
doc/source/usage/osc_cli_plugins.rst Normal file
View File

@ -0,0 +1,11 @@
Using Octavia CLI extensions to OpenStack Client
================================================
List of released CLI commands available in openstack client. These commands
can be referenced by doing ``openstack help loadbalancer``.
.. toctree::
:glob:
:maxdepth: 2
osc/v2/*