Commit Graph

241 Commits

Author SHA1 Message Date
syed ahsan shamim zaidi
704dc90d9a Change in openstack CLI keystone-warning message
Change-Id: I70224139da8dc86c8230e66df630b8bd2eedb484
Closes-Bug:#1494753
2015-10-14 07:22:03 +00:00
Christian Berendt
ce4f1067ae Remove duplicate manila entry from clients.yaml
Change-Id: Ib6ca24d9ee80bb70563e2f664307d7d14c88e879
2015-10-13 14:55:05 +00:00
Atsushi SAKAI
24d7f3be3f Add python-gnocchiclient entry for CLI-generation
Change-Id: If2f8314b57541454fbb06c9ded21e3f07987b964
Closes-Bug: #1503242
2015-10-06 20:13:02 +09:00
Peter Stachowski
5e245caece Added new commands for trove-manage
Two new commands are now available for the trove-manage utility.
They are:

datastore_version_flavor_add
datastore_version_flavor_delete

These were added to the clients.yaml file so they're processed properly
when generating the CLI reference documentation.

Change-Id: Ibaff3c14485dec2d31e46f494e6acaf380dc7150
2015-10-03 15:42:49 +00:00
Deepti Ramakrishna
1623a2ab09 Fix oversight in patch 221559
In patch 221559 with change id Ic3fc9ed5f3644497e4dd25a92ded01ee0224cdef,
a couple of calls to generate_subcommands() were not replaced with the
new method discover_and_generate_subcommands(). Fixing it in this patch.

Change-Id: I4f46d275a15685dc76e42b24b21b4930a94bc184
2015-09-30 00:42:26 -07:00
Deepti Ramakrishna
97c0faba7a Generate openstackclient subcommands from setting identity API to v3
The current client reference manual contains openstackclient subcommands for
default versions of all project APIs. For identity API, the default is v2.
Which means subcommands related to "domain" and other identity v3 concepts are
not listed. This patch generates a separate section for the new openstack
subcommands obtained by using v3 identity API. Note that we list only the
diff in the new section rather than the complete subcommand list since
non-identity subcommands (e.g. neutron, glance, etc) will not vary by changing
identity API version.

An alternate solution might be to simply change identity API version to v3
instead of the current v2 and not bother about generating separate sections
for v2 and v3. I verified that v3 subcommands are not a strict superset of
v2 commands (we lose 2 subcommands). So, we need separate sections.

Change-Id: Ic3fc9ed5f3644497e4dd25a92ded01ee0224cdef
Co-Authored-By: Shashirekha Gundur <shashirekha.j.gundur@intel.com>
Closes-Bug: #1477935
2015-09-24 00:35:01 -07:00
Christian Berendt
a5022015b9 Remove MagnetoDB from clients.yaml file
MagnetoDB will be dropped after the Tokyo summit. No more need to keep
it in the clients.yaml file.

Change-Id: Ic6b8950a6d9282220e74519f56e6a99d7045623d
2015-09-21 13:37:45 +02:00
Christian Berendt
92dda518f4 openstack-auto-commands: fix issues with python-glanceclient 1.0.0
* explicitly set --os-image-api-version 1

This is necessary because python-glanceclient 1.0.0 will use v2 when v2
is accessible.

* only extract subcommands from lastline of bash-completion output

This is necessary because 'glance bash-completion' outputs a
warning starting with python-glanceclient 1.0.0.

---snip---
WARNING: The client is falling back to v1 because the accessing to v2
failed. This behavior will be removed in future versions
---snap---

Change-Id: I936f5704e3badd4cb12d3d9c0753eb154bf594b2
2015-08-31 22:12:19 +02:00
Atsushi SAKAI
1e5d305514 Fix XML file generation error for cli-reference in murano case
<section> is not closed by </section>

Change-Id: I7481c6f2fc1d699d0c0dabc91a1b8efcb10eb269
Closes-Bug: #1489022
2015-08-26 23:31:40 +09:00
Atsushi SAKAI
dba8e4ac01 Fix mis-option identification for doc-tools-update-cli-reference
Fixes
1)"--json JSON JSON" case
2)"--id <cluster_id> ID" case

Change-Id: Ide1edce538c7316a1ddd7e6ddc9bd4b7aacfc43e
Closes-Bug: #1488505
2015-08-26 12:09:11 +09:00
Jenkins
6f546de9ba Merge "Python 3: Fix os_doc_tools/commands.py" 2015-07-27 06:40:13 +00:00
Jenkins
e16235f9bd Merge "Improve python 3 compatibility" 2015-07-27 06:33:51 +00:00
Gauvain Pocentek
a92753f4cb Remove the heat-ref related tools
Since the hot-ref and hot-guide are going back to the heat repository,
some tools are not needed anymore:
- dn2osdbk
- the hotref sphinx extension

Change-Id: I9f8539f73b4dedc5236f8ff5d5b03c93c602c661
Depends-On: Ie2240d2fca5d6e43b1d186645e7ff9107514f289
2015-07-22 20:10:08 +00:00
Andreas Jaeger
83ee2ec45d Python 3: Fix os_doc_tools/commands.py
Fix os_doc_tools/commands.py for python 3:
* check_output needs to return unicode
* Remove extra whitespace for print

Change-Id: I6edf08cf2efd3fb5dd77309d10883786a9e320de
2015-07-19 10:34:16 +02:00
Andreas Jaeger
13f340fd84 Improve python 3 compatibility
check_output returns bytes, add extra argument universal_newlines so
that the output is a string and thus can be used by other functions.

openstack-doc-test should work now using python 3 and python 2, thus
enhance setup.cfg to mark python 3 support.

Change-Id: Ic9873702977acad63d94c426c0c7e69f331a1360
2015-07-19 09:31:02 +02:00
Andreas Jaeger
bb3d68fba8 Drop python 2.6 workaround
Remove check_output that is in python 2.7 and newer but not in
python 2.6. Thus, we do not support python 2.6 anymore.

Change-Id: Ie953ce43d792b95e348a55fea4665b1ef59b468d
2015-07-19 09:30:55 +02:00
Andreas Jaeger
7c9c21f5e5 Improve python 3 compatibility for doctest.py
Fix import of urllib.
Use "print(" instead of "print ("

Change-Id: I3bc6e086c64ed8b84104e4c5bf76f46b932ceb2e
2015-07-17 13:40:40 +02:00
Andreas Jaeger
5e9b716092 Always build index for checkbuild
Always build the index files during checkbuild. With RST guides, the
index was not build everytime.

Also, update the Release Notes.

Change-Id: I2b7f2e02e81de8255307d5a0b1b3f10f73c13273
2015-06-26 10:50:22 +02:00
Ekaterina Chernova
17c1e9fa26 Support 'murano' in openstack-auto-commands
Change-Id: I821889967cbfe21694a21caa66408616e9fec861
2015-06-24 17:58:57 +03:00
Andreas Jaeger
dec4db24b4 Sort entries in index.html
Sort the entries in index.html generated by openstack-doc-test for
previewing changes.

Change-Id: Ia47351f7f0b067ce8dd97798eeb0063aaccbdf23
2015-05-08 20:19:58 +02:00
Andreas Jaeger
4282827471 openstack-doc-test: Fix index.html
Remove www pages from index, we have the index file for it.

Change-Id: Ic06c5708f888a3ab7fb678f845d36dd599461dd1
2015-05-08 10:24:04 +02:00
Andreas Jaeger
4eadc65172 Do no build Debian Install Guide by default
Disable building of the Guide by default, add a switch to enable it.
We're not publishing the Guide in current releases at all, so no
need to build it.

Change-Id: I31f235bce2e65b5de4ca2528c85c8c06d8550626
2015-05-06 20:45:42 +02:00
Christian Berendt
fcfe1f6af3 Further improvements for openstack-auto-commands
* new command for trove-manage
* automatically identify deprecated subcommands
* move client definitions into a YAML resource file
* support of the complete subcommand
* add new clients: barbican, designate, manila, magnetodb,
  manila, mistral, tuskar

Clients to be added in the future:

  * congress (module for python-openstackclient)
  * magnum (no released version)
  * murano (missing --version parameter)
  * zaqar (module for python-openstackclient)

Change-Id: I5ccb5af887749ec22a9d980e3b031de6a247041e
2015-05-04 16:50:24 +02:00
Christian Berendt
1e32726db2 Improve openstack-auto-commands
* add support for bash-completion for python-glanceclient
* add missing commands for python-swiftclient

Change-Id: I495ab17e0acbf0f33c3d306ec0a5bdf0d5d41560
2015-04-30 23:01:45 +02:00
Doug Hellmann
d797ef81cd Drop use of 'oslo' namespace package
The Oslo libraries have moved all of their code out of the 'oslo'
namespace package into per-library packages. The namespace package was
retained during kilo for backwards compatibility, but will be removed by
the liberty-2 milestone. This change removes the use of the namespace
package, replacing it with the new package names.

The patches in the libraries will be put on hold until application
patches have landed, or L2, whichever comes first. At that point, new
versions of the libraries without namespace packages will be released as
a major version update.

Please merge this patch, or an equivalent, before L2 to avoid problems
with those library releases.

Blueprint: remove-namespace-packages
https://blueprints.launchpad.net/oslo-incubator/+spec/remove-namespace-packages

Change-Id: Ib17a74ada3122ce45c52fdd7dcf8d27fafbb1d70
2015-04-28 22:18:23 +00:00
Christian Berendt
2af10c9992 Use parameter instead of option
Change-Id: I042ce268840f2c0ad57305c071ceeea74b1423c4
2015-04-23 22:04:48 +02:00
Andreas Jaeger
11b7494d90 Capitalize project names correctly
Update capitalization of project names.

Change-Id: Id816776b594ad4cf0e630d08251fbc7b084c083e
2015-04-14 21:10:26 +02:00
Andreas Jaeger
3f4165265a Handle User Guides
Handle guides that have no content subdirectory for creation of the
preview index.html file. Examples are the User Guides.

Change-Id: I4c647ee997a4776011db2677d2a84237989f0a06
2015-04-03 21:27:47 +02:00
Jenkins
1b5f0b0360 Merge "[commands] extract correct version string when client is deprecated" 2015-03-29 15:28:43 +00:00
Christian Berendt
1d99c0725c [commands] add a deprecation note for python-keystoneclient
Change-Id: Id99bbef0e9c71568b2dc018221ed2b8a1cb00110
2015-03-26 14:08:49 +01:00
Christian Berendt
d1a9fc4f90 [commands] extract correct version string when client is deprecated
With the deprecation of python-keystoneclient the output of keystone
--version changed to:

DeprecationWarning: The keystone CLI is deprecated in favor of
python-openstackclient. For a Python library, continue using
python-keystoneclient. 'python-keystoneclient.', DeprecationWarning)
1.3.0

Because of that it is necessary to only handle the last line of the
output to extract the version string.

Change-Id: Ibdfaa1de4f1c8880ce1a049fec9bea3004c11fea
2015-03-26 13:21:52 +01:00
Christian Berendt
60fae1d6e9 [commands] use --os-auth-type token only for python-openstackclient
After the merge of I14c9479ef7ded7b7c62b0d976706e3d7e26a6cd6 the
additional parameter --os-auth-type token is used for every client. This
is wrong, the additonal parameter should only be used when generating
documentation for the python-openstackclient.

Change-Id: I801637691bfd4298859ee539c5adaf0943330836
2015-02-27 11:58:26 +01:00
Christian Berendt
25847ba82c [commands] fix generator for latest python-openstackclient
* suppress deprecation warning messages

UserWarning: Module novaclient.v1_1 is deprecated (taken as a basis for
novaclient.v2). The preferable way to get client class or object you can
find in novaclient.client module.
  warnings.warn("Module novaclient.v1_1 is deprecated (taken as a basis
for "

* use --os-auth-type token to make the openstack help command workable

ERROR: openstack Authentication type must be selected with
--os-auth-type

* add new commands

Change-Id: I14c9479ef7ded7b7c62b0d976706e3d7e26a6cd6
2015-02-26 14:40:34 +01:00
Andreas Jaeger
658f29cc2e Build index even for RST only change
Build the index.html file also when only RST files changed.

Change-Id: I50a59fad6a5ca5deda8c6aad6ad2667f9b16321a
2015-02-23 15:49:14 +01:00
Andreas Jaeger
fbef0ea1c1 Handle RST files
Do not build all manuals if only RST files are changed.

Change-Id: Ie0790d7bebd676c9430a4295fe4421cbd74cbd8c
2015-02-23 14:14:52 +01:00
Andreas Jaeger
ec79ad5672 Add option --ignore-book
This allows for example to properly ignore the Install Guides from getting
build and published.

Change-Id: Id957ec3cdfc2f67f039bbca76950dd4a1d8c34a6
Partial-Bug: #1423302
2015-02-18 20:17:17 +01:00
Jenkins
6e7c0ab6c4 Merge "Adds niceness check to avoid unwanted unicode charaters" 2015-01-09 13:27:15 +00:00
Christian Berendt
113bdc4b26 Adds niceness check to avoid unwanted unicode charaters
This check helps to avoid the usage of unicode characters like
“...” or ‘...’.

Change-Id: I53e999fc91336871e1c32c70745f7d7cf2e256cf
2015-01-09 08:30:12 +01:00
Tom Fifield
b35ef35c1c Ignore <option> tags in generatepot
After https://review.openstack.org/#/c/144685 merges,
the automatically generated configuration reference
tables will be marked up as
<option>option_name</option> = <replaceable>default_value</replaceable>

As none of this should be translated (option_name is the same
regardless of language), this patch updates generatepot to ignore
option_name s tagged with <option> for translation.

This should significantly reduce the number of strings required for
translation from the common directory in particular, where
many of the 8000-odd strings do not actually need translation.

Change-Id: I27a71fd00759c883833a7061186c93f11efac68a
2015-01-01 20:41:55 +08:00
Roger Luethi
e77e51365b Add final newline to file formatting
The JSON formatting created by jsoncheck.py omits the file's final
newline. It claims that files with such a newline need reformatting
and removes the final newline in a file when reformatting.

This patch brings jsoncheck.py in line with the rest of the tools
which prefer text files to end with a newline.

Update release notes for pushing out the bug fix.

Closes-Bug: #1403159
Change-Id: I35eab544b183c05b167ce9917d92f0f1f919b745
2014-12-16 22:02:24 +01:00
Christian Berendt
a86c86f39c Add new parameter --url-exception to not check URLs for reachability
There exists URLs that are not reachable but are still valid URLs.
Those URLs should not be checked for reachability.

Change-Id: I268ef741f20200d59191a383d20a8fbeba134fb3
2014-12-11 20:43:48 +01:00
Christian Berendt
8d64912609 Add ironic to the list of supported commands in os_doc_tools.commands
Change-Id: I95425232f3eca30bb07694c31e6b4af20ca76d17
2014-12-03 21:09:23 +01:00
Christian Berendt
84dd23854d Add sahara to the list of supported commands in os_doc_tools.commands
Change-Id: I1da735152db6c40a3948c24627b86f68cdedb4d2
2014-12-03 17:22:42 +01:00
Jenkins
d611a56f5a Merge "dn2osdbk: Add a new line at the end of index pages" 2014-10-31 11:11:43 +00:00
Gauvain Pocentek
515c0b8030 dn2osdbk: Add a new line at the end of index pages
Change-Id: I3dac90b774b41d7c5aac908ae0ee61ec42c210ce
2014-10-31 12:06:14 +01:00
Gauvain Pocentek
730e0ee250 dn2osdbk: Fix string template
A missing 's' breaks the script when run with the '--toplevel chapter'
option.

Change-Id: I0d75c2a75c2e579432616235d35344269d361b0d
2014-10-30 15:42:17 +01:00
Andreas Jaeger
91586ee285 Document sahara common auth options
Sahara has a new section "Common auth", handle it when
generating the cli help.

Change-Id: Ia4a62cc634db627928ccfe365b83d37e1de36618
2014-10-29 19:20:55 +01:00
Roger Luethi
1192da60ee Use jsoncheck in doctest
This patch makes doctest use jsoncheck.

It offers:
- more helpful syntax error messages (courtesy of demjson)
- additional niceness checks for standardized formatting

Change-Id: Id92c43daeb6ee17ed03052b3c9b92cbf60f3f4a5
blueprint modularize-doctest
2014-10-21 10:23:53 +02:00
Andreas Jaeger
5fedeb2af4 Split out some functions
Split out some functions from the large find_affected_books function to
make the flow easier to understand.

Change-Id: I3fe34d01d0a7277db51ccf5fea0852cd86b59589
2014-10-20 14:50:28 +02:00
Gauvain Pocentek
f24863cf4d dn2osdbk: handle internal references
The internal references were not properly created. This patches make the
:ref: inline markup create a <xref> tag when the reference is internal.

This patch also reworks the sphinx extension to handle the URLs that
will be generated in the hot-reference with the new :ref: behavior.

Closes-Bug: #1378073
Change-Id: I84bf268dc1055dc6b39f23c4415734184ec57eec
2014-10-11 07:58:38 +02:00