python-troveclient/doc/source/pydocs.rst

PyDocs
=================

troveclient
--------------


.. automodule:: troveclient
    :members:
    :undoc-members:
    :show-inheritance:

.. autoclass:: troveclient.compat.client.Dbaas
    :members:
    :undoc-members:
    :show-inheritance:
Adding tox to Python-RDC to make documenting the client very easy. * Added some Sphinx docs. 2012-07-16 15:16:27 -05:00			`PyDocs`
			`=================`

Removing reddwarf doc references Change-Id: I5272b50e8899cf23f5d76f5d753f0e893c04666d 2013-09-16 08:56:09 -07:00			`troveclient`
Adding tox to Python-RDC to make documenting the client very easy. * Added some Sphinx docs. 2012-07-16 15:16:27 -05:00			`--------------`


Removing reddwarf doc references Change-Id: I5272b50e8899cf23f5d76f5d753f0e893c04666d 2013-09-16 08:56:09 -07:00			`.. automodule:: troveclient`
Adding tox to Python-RDC to make documenting the client very easy. * Added some Sphinx docs. 2012-07-16 15:16:27 -05:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`

Fix building of documentation Now both the standard command "python setup.py build_sphinx" and "tox -e docs" will build the documentation. The changes: * tox.ini: Fix docs section: Remove unneeded deps line, the general deps line is just fine. Enable the command, clean up before running sphinx and use the normal command for execution. * pydocs.rst: This throw an error while building since troveclient.client.Dbaas does not exist, replace it. * index.rst: Generate table of content. No need to include the files. Change-Id: I2095ef73a76b0212e33776af925f5eaf1810be7a Partial-Bug: #1315101 2014-05-01 20:48:27 +02:00			`.. autoclass:: troveclient.compat.client.Dbaas`
Adding tox to Python-RDC to make documenting the client very easy. * Added some Sphinx docs. 2012-07-16 15:16:27 -05:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`