delta/openstack/python-cinderclient.git/doc/source/index.rst, branch stable/zed

Python API in python-cinderclient

2020-09-15T17:35:15+00:00

"myvol.delete" should be "myvol.delete()"

Change-Id: Iadddfed8deec1f0dee2b71effb3b4de2689d6ada
Closes-Bug: #1866374

Add doc linting to pep8 target

2020-06-05T14:53:12+00:00

This adds doc8 to the pep8 job to lint the docs. Also fixes a few issues
it highlighted.

Change-Id: Id0f4b9bee1f6a0103ec581b20037a9b74201aaca
Signed-off-by: Sean McGinnis

Ussuri contrib docs community goal

2020-03-05T14:31:16+00:00

This patch standardizes the CONTRIBUTING.rst file and adds
doc/source/contributor/contributing.rst

Change-Id: I892e49f96573b77b46bd8847a5d2ac8254e8e5e1

Update docs to refer to PROJECT instead of TENANT

2019-09-10T20:56:27+00:00

Updates several references for things like OS_TENANT_NAME and
--os-tenant-name.

Change-Id: If71710740b4d4573a1b3f515a5762a4f82bc727d
Signed-off-by: Sean McGinnis

Cleanup the home page

2018-12-04T22:32:19+00:00

Good lord this thing needed some love. This change
does a few things:

* Remove the duplicate man page.
* Rename some titles to drop the CINDERCLIENT yelling -
  this is docs about cinderclient, I get it, no need to
  repeat in all caps.
* Fixed the sub-section title formatting in the home page.
* Dropped the duplicate usage guide wording and simply linked
  to the user docs from the home page.

Change-Id: I259787a40151e8c875ad87021f655a141e06b15e

Update python usage docs

2018-03-22T16:50:51+00:00

The keystoneauth1 get_plugin_loader method requires that a
OS_USER_DOMAIN be specified.  Our docs don't include that
detail.

This change adds the extra needed field.  There's also some
problems currently with loading the client directly as it's
currently documented, which appears to be a bug in the client
code itself.

Change-Id: Idacbb47f9aae1e461379eec4a5e224b0157a8dc4
Partial-Bug: #1758104

Use Sphinx 1.5 warning-is-error

2017-08-22T10:41:50+00:00

With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.

Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5

Rearrange existing documentation to fit the new standard layout

2017-07-27T02:54:59+00:00

The layout is configured to follow the design from this spec:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

This change is necessary to continue the doc migration process.

Change-Id: I5ab2e47b67baf90bdd808cb831493a010d23a070

import content from cli-reference in openstack-manuals

2017-07-27T01:46:02+00:00

This patch is part of the great doc migration from
openstack-manuals to the individual repos.  The
changes are based on the spec here:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

The cinder.rst file needs to be renamed index.rst so
that the template that is being used by OpenStack
manuals team will magically find the documentation.

Change-Id: Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f

Update URLs in documentation

2017-07-20T07:20:11+00:00

Update URLs according to OpenStack document migration
BTW: Do some optimization as well (http -> https)

Change-Id: I9239e2012442f3e459a21f50afd380c8f58a6a98