delta/openstack/python-novaclient.git/doc/source/conf.py, branch kilo-eol opendev.org: openstack/python-novaclient.git Add Client object to documentation 2015-03-12T00:49:04+00:00 Ian Wienand iwienand@redhat.com 2015-03-11T04:29:14+00:00 e9c70598f33af40791c2c14a9c84b415ac374c58 After wanting to do a rather simple thing -- figure out of the "timeout" argument to nodepool was a int or a float, it lead me down the rabbit-hole to python-novaclient. It turns out the timeout does get passed through to requests as a float so that mystery was solved. But the "Client" class seems to be missing from the documentation as it's not included in the class list. So add that and also at least document the types of the arguments. However, then I noticd that this wasn't showing up; turns out sphinx requires "autoclass_content = both" if you want it to document __init__() functions. Several other classes had their init args documented but they weren't showing up because of this. Change-Id: I8f44e92f2a0f25a75926b1813a8b374e79b4f5db 
After wanting to do a rather simple thing -- figure out of the
"timeout" argument to nodepool was a int or a float, it lead me down
the rabbit-hole to python-novaclient.

It turns out the timeout does get passed through to requests as a
float so that mystery was solved.

But the "Client" class seems to be missing from the documentation as
it's not included in the class list.  So add that and also at least
document the types of the arguments.

However, then I noticd that this wasn't showing up; turns out sphinx
requires "autoclass_content = both" if you want it to document
__init__() functions.  Several other classes had their init args
documented but they weren't showing up because of this.

Change-Id: I8f44e92f2a0f25a75926b1813a8b374e79b4f5db
Update version of novaclient in the docs 2015-03-03T09:59:15+00:00 Andrey Kurilin akurilin@mirantis.com 2015-02-27T13:27:22+00:00 574016a9ad01272876abb91efd3d287b97b09c7e docs config contains variables 'version' and 'release', which is a little bit outdated. Since these variables are not used, let's comment them(they can be helpful in future). Change-Id: I39f41002f69efc48841e7703b0c767bda0448c09 
docs config contains variables 'version' and 'release', which is a little bit
outdated. Since these variables are not used, let's comment them(they can be
helpful in future).

Change-Id: I39f41002f69efc48841e7703b0c767bda0448c09
Rename v1_1 to v2 2015-02-04T15:40:46+00:00 Andrey Kurilin akurilin@mirantis.com 2015-02-03T00:32:58+00:00 0a60aae852d2688861d0b4ba097a1a00529f0611 Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3. Since future development(microversioning) will be done across V2, implementation should be done in appropriate module(to prevent misleading). Despite the fact that implementation for all versions are equal, discover method for contrib path worked only for v1.1. This patch fixes this bug and modifies shell tests to check all versions. Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b 
Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3.
Since future development(microversioning) will be done across V2,
implementation should be done in appropriate module(to prevent misleading).

Despite the fact that implementation for all versions are equal, discover
method for contrib path worked only for v1.1. This patch fixes this bug and
modifies shell tests to check all versions.

Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
Stop using intersphinx 2014-09-13T07:44:39+00:00 Andreas Jaeger aj@suse.de 2014-09-13T07:44:39+00:00 cd566223006b3638f5e4fefa003631646ff6f530 Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910 
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)

This also removes the requirement for internet access during docs build.

This can cause docs jobs to fail if the project errors out on
warnings.

Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
Start using oslosphinx theme for docs 2014-03-26T11:42:03+00:00 Sergey Lukjanov slukjanov@mirantis.com 2014-03-26T11:41:37+00:00 21f166b623415ba136e8ea0a95635d545db9aeed Change-Id: Ic327d9752e9c77e6543f23b032c8b77abd6ed479 
Change-Id: Ic327d9752e9c77e6543f23b032c8b77abd6ed479
Added v3 interfaces in reference doc 2014-01-03T05:57:56+00:00 JUN JIE NAN nanjj@cn.ibm.com 2013-12-18T08:29:50+00:00 77fe8288700e07ae9fd23dfe12ca60fbd02e41ec Added hosts, agents, flavors and so on into reference doc Change-Id: I32198a0e65551f6ea3c67b72a8d7c6dff7da9f91 
Added hosts, agents, flavors and so on into reference doc

Change-Id: I32198a0e65551f6ea3c67b72a8d7c6dff7da9f91
Enable pep8 check for config.py in doc 2014-01-03T05:53:53+00:00 JUN JIE NAN nanjj@cn.ibm.com 2013-12-21T03:28:12+00:00 25041fe6fa18c78fe0216423c307af65f1b2006c Directory doc is excluded from pep8 check in tox.ini, since we modified file doc/source/config.py, we should enable the check. Change-Id: I057f1e6cb1c5f9a6a07043056078e4475f66f288 
Directory doc is excluded from pep8 check in tox.ini, since we
modified file doc/source/config.py, we should enable the check.

Change-Id: I057f1e6cb1c5f9a6a07043056078e4475f66f288
Generate interfaces reference doc 2014-01-03T05:51:08+00:00 JUN JIE NAN nanjj@cn.ibm.com 2013-12-18T08:04:58+00:00 3582d6f1be6ee652abdc6ee7e8896fade240ffb1 Add gen_ref in conf.py to generate reference doc to avoid maintaining these boilerplates. Change-Id: I6683c41d39685dcb7f7a619a36210a987c9e9825 
Add gen_ref in conf.py to generate reference doc to avoid maintaining
these boilerplates.

Change-Id: I6683c41d39685dcb7f7a619a36210a987c9e9825
Removed duplicated import 2013-12-23T02:36:35+00:00 JUN JIE NAN nanjj@cn.ibm.com 2013-12-23T02:36:35+00:00 7bd5b78b225a431d33907cdca64dbcb582255a51 sys is imported twice so removed the second import. Change-Id: I50531edf856d42ec9b10732eff18a97d0cb3e9cc 
sys is imported twice so removed the second import.

Change-Id: I50531edf856d42ec9b10732eff18a97d0cb3e9cc
Fixed autodoc can't import/find class error 2013-12-18T07:56:50+00:00 JUN JIE NAN nanjj@cn.ibm.com 2013-12-16T06:07:24+00:00 f3d6f1d22ca178b4f18406702b8ad9e8082e413e The right module name should be `novaclient.v1_1.servers' instead of `novaclient'. Similar fix on `images', `flavors' and `exceptions'. Removed `ipgroups' and `backup_schedules' since they do not exist any more. Closes-Bug: #1056478 Change-Id: Id35f9c275fb36f3651a0bb2b0eb03c43f0aaeec1 
The right module name should be `novaclient.v1_1.servers' instead of
`novaclient'. Similar fix on `images', `flavors' and `exceptions'.

Removed `ipgroups' and `backup_schedules' since they do not exist any
more.

Closes-Bug: #1056478

Change-Id: Id35f9c275fb36f3651a0bb2b0eb03c43f0aaeec1