delta/openstack/python-troveclient.git/doc/source/index.rst, branch queens-eol

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

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

Fix building of documentation

2014-05-01T18:48:27+00:00

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

Fix build_sphinx setup target

2014-03-25T20:38:12+00:00

Change-Id: I070e5d6eaa31be360608a4d03598ccabc0dce602
Closes-Bug: #1297496