delta/openstack/python-ironicclient.git/doc/source/api_v1.rst, branch stable/stein

Follow the new PTI for document build

2018-04-19T04:15:59+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: I76e8ec019ef30fdc2d34a25a99e849407f586459

Update 'Usage' section in 'doc/source/api_v1.rst'

2018-02-22T02:07:41+00:00

When I want to get the client with 'Using Identity Service (keystone)
credentials' section, it will throw errors.(usually http 400)
After testing it is found that two variables aare missing:
  - os_user_domain_name
  - os_project_domain_name
Now added them to the document.

Change-Id: Ibdebc7cf0fc017b7eeb378b022ce5cffcd943fb2

Change tenant to project in docs and unit tests

2017-02-02T09:52:58+00:00

Change os_tenant_name to os_project_name in documentation,
client and shell unit tests.
This is follow-up change augmenting the patch
https://review.openstack.org/#/c/408235/ for consistency.

Change-Id: Iaea3ddc71dadc2991e56667988df82aa1cfaf525
Related-Bug: #1646837

Typo fix: prefered => preferred

2017-01-23T09:28:21+00:00

Change-Id: I7d34d595b0f192d8531a6a85f73c6911c864c36d

Merge "Fail with more meaningful error while creating client"

2016-08-18T20:42:26+00:00

Fail with more meaningful error while creating client

2016-08-15T11:57:16+00:00

Parameter 'endpoint' in v1 client object is mandatory if
os_ironic_api_version isn't specified. It's used to fetch version
from cache[1] and as endpoint override in session client[2]. But
since it passed via *args, it could be missing, and creation fails
with IndexError.

[1] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/v1/client.py#L42
[2] https://github.com/openstack/python-ironicclient/blob/master/ironicclient/common/http.py#L595

Change-Id: I0310f748a1254dd7e54d93f913cff53aadaff16b

Fix Quick-start example syntax.

2016-07-13T06:01:38+00:00

This patch fixes syntax of example provided by documentation.

Change-Id: I2f6a5361a2dd4af1357a99e470eef2eed9a6b4cd

Use doc8 style checker

2015-09-30T23:25:23+00:00

This uses the doc8 style checker to check that document
files conform to certain requirements, as documented at
    https://pypi.python.org/pypi/doc8.

Some files were modified because they had lines that
were longer than 79 characters.

Change-Id: I94e081e197898359676821cfcf8cb1133ed28bc5

Fix Python Ironic Client Documentation

2015-02-13T11:25:58+00:00

In the 'ironicclient Python API' page, the credential section has a little
mistake in the example. It's missing "," in the first line and a '}'
in the last. You can see it at
http://docs.openstack.org/developer/python-ironicclient/api_v1.html

Change-Id: I195f46ca7261390b0d6321bc6bdd7e8d0908af40

Fix sphinx warnings

2014-11-14T16:07:33+00:00

Getting rid of a couple of warnings that are generated during the
documentation build.

Closes-Bug: #1392780

Change-Id: I2ebc8f1ec49ff80331077a653f0e73c988153898