Open Stack

We enthusiastically announce the release of:

openstack-doc-tools 1.7.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.7.0
^^^^^

Upgrade Notes

* The *autogenerate_config_docs* set of tools has been removed.
  These were always buggy and hard to maintain, and they have been
  superseded by the "oslo_config.sphinxext" Sphinx extension.

   (https://docs.openstack.org/oslo.config/latest/reference/sphinxext
  .html)

* The "openstack-auto-commands" command and its helper script in
  "bin /doc-tools-update-cli-reference" have been removed. These have
  been superseded by the "cliff.sphinxext" Sphinx extensions.

   (https://docs.openstack.org/cliff/latest/user/sphinxext.html)

* The following scripts and tools have been removed:

  * prettify.py$

  * remove_trailing_whitespaces.sh$

  * remove_unnecessary_spaces.py$

  * retf$

  These were all indented to cleanup docs once they were already in
  tree, but our tooling and review process should be sufficient to
  catch most issues and there's limited value in submitting
  whitespace-fixup patches.

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

6a568b9 Updated from global requirements
3818d43 Avoid tox_install.sh for constraints support
4c26daf Updated from global requirements
396f4b2 Update ZUUL variables for Zuul v3
127df77 Remove setting of version/release from releasenotes
0879b05 Remove cliff-tablib dependency
bfdac72 Remove pylint
5cf91a4 Remove some useless files
ca9ff17 Remove "cleanup" tools
cb16557 Remove the 'openstack-auto-commands' tool
d3c9520 Remove 'autogenerate_config_docs'
3dd0834 Remove MANIFEST.in file
551cb5a Updated from global requirements
b27a4d2 Updated from global requirements
370698d Updated from global requirements
b914be5 Fix URLs
c67afa0 Fix to use "." to source script files
4e5a167 Updated from global requirements
fe469cc Updated from global requirements
eccac10 Cleanup doc-tools-check-languages


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

HACKING.rst                                        |   2 +-
MANIFEST.in                                        |  12 -
README.rst                                         |   6 -
RELEASE_NOTES.rst                                  |   2 +-
autogenerate_config_docs/README.rst                | 121 ----
autogenerate_config_docs/__init__.py               |  18 -
autogenerate_config_docs/autohelp-wrapper          | 273 --------
autogenerate_config_docs/autohelp.py               | 696 -------------------
autogenerate_config_docs/diff_branches.py          | 289 --------
autogenerate_config_docs/requirements.txt          |   5 -
.../templates/autohelp-category.rst.j2             |  45 --
.../templates/autohelp-group.rst.j2                |  40 --
autogenerate_config_docs/templates/changes.rst.j2  |  61 --
bin/doc-tools-check-languages                      |   4 +-
bin/doc-tools-check-languages.conf                 |  18 -
bin/doc-tools-update-cli-reference                 |  89 ---
cleanup/prettify.py                                |  72 --
cleanup/remove_trailing_whitespaces.sh             |  24 -
cleanup/remove_unnecessary_spaces.py               |  69 --
cleanup/retf/README.md                             |  69 --
cleanup/retf/disabled_rules.yaml                   |   1 -
cleanup/retf/retf.py                               | 307 --------
openstack-common.conf                              |   8 -
os_doc_tools/commands.py                           | 772 ---------------------
os_doc_tools/resources/clients.yaml                | 134 ----
pylintrc                                           |  31 -
.../notes/docs-publishing-8da43343222f613e.yaml    |   2 +-
...e-great-doc-tools-cleanup-1a79e2c200232489.yaml |  25 +
releasenotes/source/conf.py                        |  11 +-
requirements.txt                                   |  11 +-
setup.cfg                                          |   4 -
sitemap/README.rst                                 |   2 +-
test-requirements.txt                              |  10 +-
tools/tox_install.sh                               |  30 -
tox.ini                                            |  15 +-
38 files changed, 47 insertions(+), 3254 deletions(-)


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

diff --git a/requirements.txt b/requirements.txt
index da821ff..7dcd433 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -7,2 +7,2 @@ iso8601>=0.1.11 # MIT
-lxml!=3.7.0,>=2.3 # BSD
-oslo.config!=4.3.0,!=4.4.0,>=4.0.0 # Apache-2.0
+lxml!=3.7.0,>=3.4.1 # BSD
+oslo.config>=5.1.0 # Apache-2.0
@@ -10,4 +10,3 @@ docutils>=0.11 # OSI-Approved Open Source, Public Domain
-sphinx>=1.6.2 # BSD
-demjson # GLGPLv3+
-PyYAML>=3.10.0 # MIT
-cliff-tablib>=1.0 # Apache-2.0
+sphinx!=1.6.6,>=1.6.2 # BSD
+demjson>=2.2.2 # GLGPLv3+
+PyYAML>=3.10 # MIT
diff --git a/test-requirements.txt b/test-requirements.txt
index 8937ac7..393536e 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8,2 +8,2 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
-bashate>=0.2 # Apache-2.0
-doc8 # Apache-2.0
+bashate>=0.5.1 # Apache-2.0
+doc8>=0.6.0 # Apache-2.0
@@ -13,2 +13,2 @@ pylint==1.7.1 # GPLv2
-reno!=2.3.1,>=1.8.0 # Apache-2.0
-openstackdocstheme>=1.16.0 # Apache-2.0
+reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.17.0 # Apache-2.0
@@ -18 +18 @@ testrepository>=0.0.18 # Apache-2.0/BSD
-mock>=2.0 # BSD
+mock>=2.0.0 # BSD