5 Commits

Author SHA1 Message Date
Trevor McCasland
b9a20edf92 Update the trove docs to follow the docs theme
We were using the old theme on trove docs.

We should update to new theme, it includes the new logo as well!

You can see the difference in the themes here,

new, https://docs.openstack.org/admin-guide/
old, https://docs.openstack.org/developer/python-troveclient/

Change-Id: If5ff925d258f7b4008aff32b1677d7806395b5c9
2017-07-13 10:59:55 -05:00
Doug Hellmann
0d5c899edb rearrange docs into new standard layout
Also replaces inline reference guide generation with pbr's feature for
doing the same thing.

Refer to
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
for details.

Change-Id: I0fac75bfe66a1ea30973c2128c054aa2e43c8f8b
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-29 17:00:28 -04:00
Edmond Kotowski
4acdad63ac TroveClient API Documentation cleanup
- The documentation index page will now contain a
Version 1 API Reference section with links to each v1 module and
documentation for each method in that module.

- Copied python-novaclients gen_ref method into the doc/source/conf.py file
that dyanamically generates the sphinx .rst files for each trove v1 module.
When it runs it will create generate a new folder named ref/v1/ and will
contain each module such as instances.rst with the filled out automodule
sphinx code.

Ex: /ref/v1/instances.rst

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

Change-Id: Ib311486564f5b6def205590a1ccc2e493f3fef97
2015-02-11 18:31:34 -08:00
Andreas Jaeger
4a3615d8c5 Use OpenStack branding for trove client
Add oslosphinx to get OpenStack branding.
Remove html_static_path since it's unused and issues a warning.
Update copyright year.

Change-Id: I0bdcab8ebc5a201a3f91b4a6c4724536d1157901
2014-09-19 11:53:35 +02:00
Vipul Sabhaya
77c8f5020e Fix build_sphinx setup target
Change-Id: I070e5d6eaa31be360608a4d03598ccabc0dce602
Closes-Bug: #1297496
2014-03-25 13:38:12 -07:00