Open Stack

We are eager to announce the release of:

openstack-doc-tools 0.33.0: Tools for OpenStack Documentation

This release is part of the independent release series.

With source available at:

    http://git.openstack.org/cgit/openstack/openstack-doc-tools

With package available at:

    https://pypi.python.org/pypi/openstack-doc-tools

Please report issues through launchpad:

    http://bugs.launchpad.net/openstack-manuals

For more details, please see below.

0.33.0
^^^^^^


New Features
************

* Update CLI Reference generation tool for RST. To migrate CLI
  Reference from DocBook to RST, output the documentation in RST
  format, with a few work arounds for RST/Sphinx specific issues.

* Set the bug report project to openstack-i18n for the translated
  documents.

* New command "openstack-indexpage" to only generate the HTML index
  page. The index page layout has also been improved.


Other Notes
***********

* "autohelp.py" now allows overrides of sections, defined in
  "<project>.overrides" configuration files.


Changes in openstack-doc-tools 0.32.0..0.33.0
---------------------------------------------

8c11a32 Updated from global requirements
83a7248 Add switcher for common directory
704370e Remove tuskar handling
30afce8 Fix two word spellings
41a1197 Add Topic tag in cli-reference generated script
d0c8b27 autohelp: fix poor behavior of _sanitize_default
5dc95bf autohelp: avoid duplicated overriden entries
4424323 [sitemap] do not add empty URLs to the list of start URLs
49e3299 Rename pep8 to linters test
d1f1ea7 Remove unused requirements
4403ef6 Address pep8 warning at doc-tools-check-languages
b4f4013 Address pep8 warning at markdown-docbook.sh
cc8d24c Address pep8 warning at autohelp-wrapper
3b65a14 Updated from global requirements
a25b753 Update CLI Reference generation tool for RST
8ebb376 [sitemap] set higher priority for files of the current release
e436173 Move the config items in the manuals repository
50c4f5e tox: remove the pypy env
c093aac autohelp: remove old files
e3c42a2 `autohelp update` can create the flags file
d0b4e74 Add Zaqar configuration options hook
df1ef23 Updated from global requirements
69c7c92 autohelp-wrapper: remove leftover "fi"
c8ba535 Skip non-existing test-requirements with pip install
62fb731 Install optional cliff dependency
3b8080f Update osc plugins
1c3a82d Add testrepository to test-requirements
8af65b5 py33 is no longer supported by Infra's CI
d1381c5 Put py34 first in the env order of tox
f812c40 [autohelp] Update the component names
658c74d [autohelp] config-ref-rst moves to config-reference
e8784d2 [autohelp] display information on import error
05df4d8 autohelp: add keystone modules to ignore list
29ca622 Update python-xxxclient for python-openstackclient
7f0b19d Mark Block Storage API v1 as deprecate
6f4a975 Set the bug project to i18n for the translated docs
58136d4 Add additional openstack client plugins
00e4f6e [diff_branches] Handle empty values in RST tables
5699190 Updated from global requirements
06e6e04 [autohelp] Avoid long lines in templates
164ee15 [diff_branches] Projects can be passed as arguments
3e539d3 Insert property keys section into glance chapter
5c743c3 [autohelp] allow overrides of sections
05a6ce2 Simply rmdir usage with --ignore-fail-on-non-empty
54d0508 [autohelp] Simple neutron handling
66acf4f Update autohelp template for Config Reference
1f8aace Update command line list on clients.yaml
57c8e9a Add -W to sphinx invocation for release-notes build
5c930e2 [autohelp] misc fixes
39b5ecf Improve index page layout
d881430 [autohelp] Add table label for RST reference
50589f3 autohelp: avoid help strings on multiple lines
bf38181 Add python-openstackclient required plugin package
47481e2 Updated from global requirements
02b8df9 Fix for getting glance command list
885bbcd Update README for autogenerate_config_docs
19fba83 diff_branches: fix deprecated opts listing
2078492 diff_branches: master is Mitaka
43ee2e9 autohelp: workaround for empty values in RST literals
8391493 Reno: Remove unreleased and merge with index
fca3ac6 autohelp: add aodh to the projects list

Diffstat (except docs and test files)
-------------------------------------

autogenerate_config_docs/README.rst                |  16 +-
autogenerate_config_docs/autohelp-wrapper          |  75 ++--
autogenerate_config_docs/autohelp.ignore           |  27 --
autogenerate_config_docs/autohelp.py               | 109 +++--
autogenerate_config_docs/diff_branches.py          |  46 ++-
.../extra_repos/neutron-master.txt                 |  33 --
autogenerate_config_docs/extract_swift_flags.py    |  10 +-
autogenerate_config_docs/flow.dia                  | Bin 3206 -> 0 bytes
autogenerate_config_docs/hooks.py                  |  81 ----
.../notes/conf-in-manuals-f2d57e04ee35741f.yaml    |   4 +
.../notes/update-can-create-097dd0790567eeb5.yaml  |   3 +
.../requirements/cinder-juno.txt                   |   2 -
.../requirements/neutron-juno.txt                  |   1 -
.../requirements/neutron-kilo.txt                  |  43 --
.../requirements/neutron-master.txt                |  60 ---
autogenerate_config_docs/templates/autohelp.rst.j2 |   8 +-
autogenerate_config_docs/templates/changes.rst.j2  |  15 +-
autogenerate_config_docs/test/README.md            |   3 -
autogenerate_config_docs/test/genconfs.sh          |  30 --
autogenerate_config_docs/test/generator.py         | 259 ------------
bin/doc-tools-build-rst                            |   8 +-
bin/doc-tools-check-languages                      | 103 +++--
bin/doc-tools-update-cli-reference                 |  21 +-
os_doc_tools/commands.py                           | 451 ++++++++++-----------
os_doc_tools/doctest.py                            |  66 +--
os_doc_tools/index.py                              |  96 +++++
os_doc_tools/resources/clients.yaml                |  39 +-
os_doc_tools/scripts/markdown-docbook.sh           |  22 +-
.../notes/autohelp-overrides-b076159cc00891b3.yaml |   3 +
.../notes/cli-ref-rst-20365acfdba086f2.yaml        |   6 +
.../notes/i18n-bug-report-b1031955789ee343.yaml    |   4 +
.../notes/separate-index-cce0ae4286f1da53.yaml     |   4 +
releasenotes/source/index.rst                      |   5 +-
releasenotes/source/unreleased.rst                 |   5 -
requirements.txt                                   |  15 +-
setup.cfg                                          |   1 +
sitemap/generator/spiders/sitemap.py               |  40 +-
test-requirements.txt                              |   4 +-
tox.ini                                            |   9 +-
39 files changed, 673 insertions(+), 1054 deletions(-)


Requirements updates
--------------------

diff --git a/requirements.txt b/requirements.txt
index 9d1fae2..064da08 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5,7 +5,6 @@
-pbr>=1.6
-argparse
-Babel>=1.3
-iso8601>=0.1.9
-lxml>=2.3
-oslo.config>=2.6.0 # Apache-2.0
-sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
+pbr>=1.6 # Apache-2.0
+Babel>=1.3 # BSD
+iso8601>=0.1.9 # MIT
+lxml>=2.3 # BSD
+oslo.config>=3.4.0 # Apache-2.0
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
@@ -13 +12 @@ demjson # GNU LGPL 3.0
-PyYAML>=3.1.0
+PyYAML>=3.1.0 # MIT
diff --git a/test-requirements.txt b/test-requirements.txt
index 29c58e4..a04e283 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -10 +10 @@ hacking<0.11,>=0.10.0
-pylint==1.4.4 # GNU GPL v2
+pylint==1.4.5 # GNU GPL v2
@@ -13 +13 @@ reno>=0.1.1 # Apache2
-oslosphinx>=2.5.0 # Apache-2.0
+oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0