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
Removing the Rackspace Auth references that are not
supported by an openstack deployment.
Co-Authored-By: Craig Vyvial <cp16net@gmail.com>
Change-Id: I7e630a77eaeb31de0962b31bc2f86becf2975dd8
Closes-Bug: #1401804
- 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
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
Add oslosphinx to get OpenStack branding.
Remove html_static_path since it's unused and issues a warning.
Update copyright year.
Change-Id: I0bdcab8ebc5a201a3f91b4a6c4724536d1157901
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
