23 Commits

Author SHA1 Message Date
Andrey Kurilin
0a60aae852 Rename v1_1 to v2
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
2015-02-04 17:40:46 +02:00
Jeremy Stanley
c4233cfd2a Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I75618aaf9e07324985a83ca74d35bcab59e186c1
2014-12-05 03:30:40 +00:00
Andrey Kurilin
3f64b4577b Propose 'tox' as tests launcher
Since ``tox`` is used as launcher in gates, it should be mentioned in docs
instead of ``python setup.py test``.

Change-Id: Ie5fcd9da755e1146b2b042fa5906aa28748980a6
2014-10-23 14:47:32 +03:00
Andreas Jaeger
cd56622300 Stop using intersphinx
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
2014-09-13 09:44:39 +02:00
Mark McLoughlin
9f1ee1249a Mention keystoneclient.Session use in docs
Jamie added some excellent "Using Sessions" docs to keystoneclient in
I5e44c1029ce160cb2798cfb8a535aa9f3311799a. These will be published to

  http://docs.openstack.org/developer/python-keystoneclient/using-sessions.html

once the version after 0.9.0 is released.

Let's add a brief example on how to use this API and reference the
keystoneclient docs.

Change-Id: Icbcef45f13c1f962c90aa3db9dde4360520166ff
2014-07-01 16:53:47 +01:00
Sergey Lukjanov
21f166b623 Start using oslosphinx theme for docs
Change-Id: Ic327d9752e9c77e6543f23b032c8b77abd6ed479
2014-03-26 15:42:03 +04:00
Eric Guo
dacbe0b070 Update broken command line reference link
The old reference link of nova command line was broken, update it
with latest one.

Change-Id: I4ab8a4750c7090ba20def6e47d1c4fe905a8256d
2014-02-13 23:17:34 +08:00
JUN JIE NAN
77fe828870 Added v3 interfaces in reference doc
Added hosts, agents, flavors and so on into reference doc

Change-Id: I32198a0e65551f6ea3c67b72a8d7c6dff7da9f91
2014-01-03 13:57:56 +08:00
JUN JIE NAN
25041fe6fa Enable pep8 check for config.py in doc
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
2014-01-03 13:53:53 +08:00
JUN JIE NAN
3582d6f1be Generate interfaces reference doc
Add gen_ref in conf.py to generate reference doc to avoid maintaining
these boilerplates.

Change-Id: I6683c41d39685dcb7f7a619a36210a987c9e9825
2014-01-03 13:51:08 +08:00
JUN JIE NAN
7bd5b78b22 Removed duplicated import
sys is imported twice so removed the second import.

Change-Id: I50531edf856d42ec9b10732eff18a97d0cb3e9cc
2013-12-23 10:36:35 +08:00
JUN JIE NAN
f3d6f1d22c Fixed autodoc can't import/find class error
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
2013-12-18 15:56:50 +08:00
Abhishek Chanda
e334096aa3 Remove the release.rst file
It has not been updated in a long time and does not seem to be used
Closes-Bug: #1257295

Change-Id: Ie798cc5e6c64db6afcaf22102c74e8be12d3c6a2
2013-12-10 17:03:38 +05:30
Monty Taylor
c7e62d4c57 Clean up a little cruft
OpenStack runs a git service now, so instead of linking to github URLs,
link to git.openstack.org.
Versions for pbr in setup.py actually wind up being an error (and a very
odd one) Remove them.
The setup hook in setup.cfg is no longer needed.

Change-Id: I8f48ac194e6c01e9bb06fa5df6f2b2bf28c01636
2013-09-20 16:02:48 -07:00
Chuck Short
8c4e145b92 python3: Fix unicode compatibility python2/python3
Python3 enforces the distinction between byte strings and text strings
more rigorously than python2. So use six.text_type/six.u()
where appropriate

Change-Id: I890e19cb857e10f0292aabdaebaa8e7a7bd8db23
Signed-off-by: Chuck Short <chuck.short@canonical.com>
2013-06-24 11:47:15 -05:00
Jakub Ruzicka
37da28cff4 Provide nova CLI man page.
Resolves: bug 1130815
Blueprint: clients-man-pages

Provide basic but hopefully useful man page.

Change-Id: I6c520fa3acdb82dd564b758b9cdc448eecc6d6ce
2013-05-29 18:53:42 +02:00
gtt116
dccdd02e48 Cleanup unused import
Change-Id: Id7d110110f238077630c9b9ee4d643654844dd3e
2013-04-17 13:51:37 +00:00
lrqrun
9754f1daa8 Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py make the code looks pretty.

Change-Id: I7cc284a0155d531d3890941f8c62c04f54d1a2d6
2012-08-29 13:36:55 +08:00
Dean Troyer
9101741960 Change '_' to '-' in options
This changes every command-line option with a '_' in its name
and changes them to '-'.  The old option names are maintained
for backward compatibility but are no longer in the help text.

BP command-options

Note: there is a dodgy hack in novaclient/shell.py to handle
usage-list's --end option that conflicts with --endpoint-type
if --endpoint_type is also present for backward compatibility.
If --endpoint_type is not added to the parser it works.  Go figure.
Better solutions that do not break backward compatibility are welcome.

Rebased due to https://review.openstack.org/11072 merging.
Note: --availability_zone changed to --availability-zone with no
backward compatability since this s a new option.

Change-Id: I09ab546659be0a0d3f0eadb22ab5e13fac2f059d
2012-08-24 15:22:44 -05:00
Jenkins
20aa3ab779 Merge "Small doc cleanup round." 2012-07-02 17:10:59 +00:00
annegentle
2a97d614b4 Small doc cleanup round.
- Changes theme to default instead of nature.
 - Explains in terms of Compute API instead of Rackspace
 - Remove outdated reference to nova-manage command
 - Remove unnecessary whitespace

Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
2012-06-26 09:29:38 -05:00
Clark Boylan
bb117a2d45 Update Contributing blurb in the docs.
Contributing blurb previously mentioned using Github pull requests.
Contributions should go to Gerrit instead.

Change-Id: Id7b7f968fa5a3785c19704b4c1c2408f48b335ca
2012-06-22 10:16:49 -07:00
Clark Boylan
ebceca9414 Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I868df12e3c15cc30043e782ce0a609b9574295cd
2012-06-11 14:18:48 -07:00