delta/openstack/python-troveclient.git/doc, branch 2.18.0

Follow the new PTI for document build

2018-04-21T11:37:53+00:00

- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I078e2ed32da04303203d6c2a3e498f82b9a15939

Update the trove docs to follow the docs theme

2017-07-13T15:59:55+00:00

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

Add cli to docs

2017-07-13T15:36:38+00:00

As part of phase 1, the cli reference should be moved to the local
repositories. "This content will move the project-specific client
documentation trees under doc/source/cli."[1]

I deleted the old reference and auto-generated the cli using the
tool here[2]

[1]http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html#what-is-happening-to-each-guide
[2]https://docs.openstack.org/contributor-guide/doc-tools/cli-reference.html

Change-Id: Ie1d5f2629021d738b8247c5335bce433ba5c4a05

rearrange docs into new standard layout

2017-06-29T21:00:28+00:00

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

Use lowercase project name for doc

2016-11-29T01:40:22+00:00

Projectname according to the relevant provisions of the new document
style should use lowercase, Service should be used service name instead
of project name[1].

[1]:http://docs.openstack.org/contributor-guide/writing-style/openstack-components.html

Change-Id: I385aa21b141528f7766f54cd7f067fb67eb8478e
Depends-On: I386efb2d5c147417af7ea25704405977c9b6bbcd
Depends-On: I5c1714b7839b2736c50f2daa2f4506c4006815a1

Update example usage

2016-05-24T22:21:47+00:00

The example usage was really out of date and doesn't work on modern
clients. This updates it to a functional state.

Change-Id: I96bf56e3cd3943f8c0e210dd873bc4cae02a1ea8

Remove Rackspace auth references from troveclient

2016-05-18T18:16:25+00:00

Removing the Rackspace Auth references that are not
supported by an openstack deployment.

Co-Authored-By: Craig Vyvial 

Change-Id: I7e630a77eaeb31de0962b31bc2f86becf2975dd8
Closes-Bug: #1401804

TroveClient API Documentation cleanup

2015-02-12T02:31:34+00:00

- 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

Fixed typo in doc/source

2014-10-28T13:49:28+00:00

There was a typo in the Authentication section of the usage.rst
file.

This has been fixed, along with some lining up of comments in the
test code to make it easier to read.

Change-Id: I342a286055246beaeadc7e763d3b75bd17c32a60

Use OpenStack branding for trove client

2014-09-19T09:53:35+00:00

Add oslosphinx to get OpenStack branding.
Remove html_static_path since it's unused and issues a warning.
Update copyright year.

Change-Id: I0bdcab8ebc5a201a3f91b4a6c4724536d1157901