python-monascaclient/doc/source/index.rst
kornicameister 6edcdd4af7 Enable client documentation
Commit enables following flavours of client's documentation:
- docs: featuring mainly CLI and Python API
- releasenotes: containing all releases releasenotes

Story: 2001058
Task: 5722

Needed-By: Ie064df6f64ee168ad3b5d2dda949b1d14fa7b9d8
Change-Id: I1b0fa11160d8d7d928b4cfbe358ca8c75ed8dd08
2017-11-21 17:31:06 +01:00

47 lines
1.2 KiB
ReStructuredText

..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
==================================
python-monascaclient documentation
==================================
This is a client for OpenStack Monitoring API. It provides
:doc:`Python API bindings <reference/index>` (the monascaclient module) and
:doc:`command-line interface (CLI) <cli/index>`.
User Documentation
------------------
.. toctree::
:maxdepth: 2
cli/index
reference/index
Usage
-----
In the :doc:`Usage <usage/index>`, you will find
information on possible ways to use python-monascaclient.
.. toctree::
:maxdepth: 2
usage/index
History
-------
Release notes is available at
http://docs.openstack.org/releasenotes/python-monascaclient/.