Open Stack

We enthusiastically announce the release of:

openstack-doc-tools 1.6.0: Tools for OpenStack Documentation

The source is available from:

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

Download the package from:

    https://tarballs.openstack.org/openstack-doc-tools/

Please report issues through launchpad:

    https://bugs.launchpad.net/openstack-doc-tools

For more details, please see below.

1.6.0
^^^^^


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

* The documentation for this repo has been improved and is now
  published at https://docs.openstack.org/developer/openstack-doc-
  tools.


Upgrade Notes
*************

* The *extract_swift_flags* tool no longer supports the *docbook*
  command. This previously allowed outputting of Docbook-formatted
  text but the feature was broken and unsupported by the community.
  reStructuredText should be used for everything.

* The *extract_swift_flags* tool no longer supports the *--from*
  argument. All Swift documentation has been converted to
  reStructuredText meaning there is no reason to keep this around.

* The *extract_swift_flags.py* script has been removed, and the
  *autohelp.py* and *diff_branches.py* scripts no longer build config
  file documentation for the swift project. The swift dev team had
  been manually maintaining their config files in-tree and to avoid
  duplication, doc and swift have agreed to link the config ref out to
  the dev docs. As such, there is therefore no reason to keep this
  tooling around.

Changes in openstack-doc-tools 1.5.0..1.6.0
-------------------------------------------

980c84a Remove handling of install-guide/config-reference for Pike
5f4394c Make openstack-doc-tools can be used in the individual client repos
fb838cf Do not add EOL releases to sitemap
6898821 Change priorities for sitemap
f87192c Updated from global requirements
d4c18f5 sitemap: Add ocata
9c10de3 Document installation of scrapy via pip
c3bf1aa Switch to openstackdocstheme
58eeb19 Updated from global requirements
3c27d9f Add openssl libs to bindep
d6eeb8e Updated from global requirements
2df1a73 Updated from global requirements
380b53c Updated from global requirements
b5742da [diff_branches] remove the broken --format option
14623e7 Add bindep.txt
e136fd3 Updated from global requirements
5a6b867 Add release-note about docs
00ed2ea Update index page
0e52670 Update RELEASE_NOTES
ea1ae95 Update docs theme configuration
d3bc424 Update sitemap tests
4534f04 [autohelp] Update opt types
53de7de [autohelp] Return options as dicts instead of lists
cec1dd2 Updated from global requirements
e90895e Remove swift tooling
efdab27 Actually skip 'update' when flagmapping are disabled
81f7a8f option.help can be None
8910036 [cli-ref] add API version for cinder explicitly
eb74019 Add missing doc for dump in autohelp-wrapper
883067f Updated from global requirements
9a7a07d Handle object type when registering runtime options in autohelp
74b9810 Allow overriding of openstack-manuals dir
b4492e3 trivial: Remove 'pass_through'
d962670 Make flagmapping optional
88ae9f0 Separate option formatting
d77ab16 Index options by group too
2860b9d Simplify the format of paragraphs
f0a146d Include 'deprecation' as a flag
cebdd12 Remove unnecessary parameter
700b228 [cli-ref] add line break to avoid lengthy line
6d6f122 extract_swift_flags: Remove '--from' argument
80d376e extract_swift_flags: Remove 'docbook' command
e71cc26 Updated from global requirements
c83fd72 Updated from global requirements
6cf30af Updated from global requirements
f52c24f Update hacking


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

.gitignore                                         |   1 +
README.rst                                         |  15 +-
RELEASE_NOTES.rst                                  |  26 +-
autogenerate_config_docs/README.rst                |  24 +-
autogenerate_config_docs/autohelp-wrapper          |  37 +--
autogenerate_config_docs/autohelp.py               | 180 +++++++----
autogenerate_config_docs/diff_branches.py          |  27 +-
autogenerate_config_docs/extract_swift_flags.py    | 339 ---------------------
.../templates/autohelp-category.rst.j2             |  45 +++
.../templates/autohelp-group.rst.j2                |  40 +++
autogenerate_config_docs/templates/autohelp.rst.j2 |  34 ---
autogenerate_config_docs/templates/swift.rst.j2    |  15 -
bin/doc-tools-check-languages                      | 117 -------
bin/doc-tools-update-cli-reference                 |  10 +-
bindep.txt                                         |   9 +
os_doc_tools/commands.py                           |   5 +-
os_doc_tools/test/__init__.py                      |   0
os_doc_tools/test/test_index.py                    |  37 ---
os_doc_tools/test/test_jsoncheck.py                |  98 ------
.../notes/docs-publishing-8da43343222f613e.yaml    |   4 +
...-from-extract_swift_flags-1bd83bc1b68fe056.yaml |  11 +
.../remove-swift-support-54f2d2d9c78cbb58.yaml     |   9 +
releasenotes/source/conf.py                        |   9 +-
requirements.txt                                   |   6 +-
setup.py                                           |   2 +-
sitemap/README.rst                                 |  88 ++++--
sitemap/generator/pipelines.py                     |   4 +-
sitemap/generator/spiders/sitemap_file.py          |  55 ++--
sitemap/requirements.txt                           |   1 -
sitemap/test/__init__.py                           |   0
.../test/generator/spiders/test_sitemap_file.py    | 110 -------
sitemap/test/generator/test_items.py               |  37 ---
sitemap/test/generator/test_pipelines.py           | 202 ------------
test-requirements.txt                              |  12 +-
test/__init__.py                                   |   0
test/test_index.py                                 |  37 +++
test/test_jsoncheck.py                             |  98 ++++++
test/test_pipelines.py                             | 197 ++++++++++++
test/test_sitemap_file.py                          | 147 +++++++++
tox.ini                                            |  26 +-
49 files changed, 965 insertions(+), 1222 deletions(-)


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

diff --git a/requirements.txt b/requirements.txt
index 0797fc8..da821ff 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -5 +5 @@
-pbr>=1.8 # Apache-2.0
+pbr!=2.1.0,>=2.0.0 # Apache-2.0
@@ -8 +8 @@ lxml!=3.7.0,>=2.3 # BSD
-oslo.config!=3.18.0,>=3.14.0 # Apache-2.0
+oslo.config!=4.3.0,!=4.4.0,>=4.0.0 # Apache-2.0
@@ -10 +10 @@ docutils>=0.11 # OSI-Approved Open Source, Public Domain
-sphinx>=1.5.1 # BSD
+sphinx>=1.6.2 # BSD
diff --git a/test-requirements.txt b/test-requirements.txt
index 52ebe21..8937ac7 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -4,0 +5,3 @@
+# Hacking already pins down pep8, pyflakes and flake8
+hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
+
@@ -8,6 +11 @@ doc8 # Apache-2.0
-# Hacking already pins down pep8, pyflakes and flake8
-hacking<0.12,>=0.11.0 # Apache-2.0
-pylint==1.4.5 # GPLv2
-
-reno>=1.8.0 # Apache-2.0
-oslosphinx>=4.7.0 # Apache-2.0
+pylint==1.7.1 # GPLv2
@@ -14,0 +13,2 @@ oslosphinx>=4.7.0 # Apache-2.0
+reno!=2.3.1,>=1.8.0 # Apache-2.0
+openstackdocstheme>=1.16.0 # Apache-2.0