Commit Graph

16 Commits

Author SHA1 Message Date
likui 3bdae37673 remove unicode from code
Change-Id: Iadc87779bf513c9d04847b6cf8ecbc60b300d7db
Implements: blueprint remove-unicode
2021-01-03 13:03:32 +08:00
Andreas Jaeger 0ce00bb569 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_auto_name to use 'project' as name.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ib5706db978edfdddb88230ee81a563c7976f238a
2020-05-22 17:20:01 +00:00
Lingxian Kong 27cf71299e Remove flavor API
Change-Id: I5a35911b5658fdf6bc08844b31cc1325b749526a
2020-05-08 00:30:49 -06:00
Andreas Jaeger 4757668582 Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove section from setup.cfg: Wheel is not needed for python
  3 only repo
- Remove html_last_updated_fmt from source/conf.py, this is not
  needed anymore.

Change-Id: If9708106263493396693771e9bd5265e26de460c
2020-04-04 11:21:19 +02:00
Nguyen Hai 3c70f8f69e Follow the new PTI for document build
- 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
2018-04-21 11:37:53 +00:00
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
Trevor McCasland 5ff9b6183e Add cli to docs
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
2017-07-13 10:36:38 -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
jiansong 7b9c7e9b7d Use lowercase project name for doc
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
2016-11-29 01:40:22 +00:00
Matt Fischer b0208baa7f Update example usage
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
2016-05-24 16:21:47 -06:00
Monty Taylor 7f2f18ab33 Remove Rackspace auth references from troveclient
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
2016-05-18 13:16:25 -05: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
Peter Stachowski fbe2b0a2a8 Fixed typo in doc/source
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
2014-10-28 09:49:28 -04: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
Andreas Jaeger 21a22403ca 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
Vipul Sabhaya 77c8f5020e Fix build_sphinx setup target
Change-Id: I070e5d6eaa31be360608a4d03598ccabc0dce602
Closes-Bug: #1297496
2014-03-25 13:38:12 -07:00