CHANGES
=======

3.1.0
-----

* Switch to newer openstackdocstheme and reno versions
* Cleanup py27 support
* Update hacking for Python3
* Update sitemap for Python3

3.0.0
-----

* Add python-requires >= 3.6
* Drop python 2.7 support and testing
* tox: Keeping going with docs
* setup.cfg: Cleanup and update some urls to latest
* Switch to ussuri python3 jobs
* Update the constraints url

2.0.0
-----

* Remove openstack-jsoncheck and openstack-indexpage
* Cleanup doc-tools-check-languages
* Publish to publish-docs/html
* Remove some commented obsolete lines
* Update docs building

1.10.0
------

* Don't use special api-quick-start location

1.9.0
-----

* Add Python 3 Train unit tests
* Drop py35 testing
* Replace git.openstack.org URLs with opendev.org URLs
* OpenDev Migration Patch
* Update home-page
* Remove support for py34
* Update hacking
* Change openstack-dev to openstack-discuss
* Advancing the protocal of the website to HTTPS in README.rst
* Remove setup.py check from pep8 job
* Update sitemap file
* Use openstack-lower-constraints-jobs template
* add python 3.6 unit test job
* switch documentation job to new PTI
* import zuul job settings from project-config
* Switch to stestr
* fix tox python3 overrides
* Check RST as part of linting

1.8.0
-----

* [lang] Fixes PUBLISH\_DIR for api-quick-start
* add lower-constraints job
* Updated from global requirements
* Remove unused oslo.config requirement
* Updated from global requirements
* Updated from global requirements
* Update links in README
* Clean imports in code
* Updated from global requirements

1.7.0
-----

* Updated from global requirements
* Avoid tox\_install.sh for constraints support
* Updated from global requirements
* Update ZUUL variables for Zuul v3
* Remove setting of version/release from releasenotes
* Remove cliff-tablib dependency
* Remove pylint
* Remove some useless files
* Remove "cleanup" tools
* Remove the 'openstack-auto-commands' tool
* Remove 'autogenerate\_config\_docs'
* Remove MANIFEST.in file
* Updated from global requirements
* Updated from global requirements
* Updated from global requirements
* Fix URLs
* Fix to use "." to source script files
* Updated from global requirements
* Updated from global requirements
* Cleanup doc-tools-check-languages

1.6.0
-----

* Remove handling of install-guide/config-reference for Pike
* Make openstack-doc-tools can be used in the individual client repos
* Do not add EOL releases to sitemap
* Change priorities for sitemap
* Updated from global requirements
* sitemap: Add ocata
* Document installation of scrapy via pip
* Switch to openstackdocstheme
* Updated from global requirements
* Add openssl libs to bindep
* Updated from global requirements
* Updated from global requirements
* Updated from global requirements
* [diff\_branches] remove the broken --format option
* Add bindep.txt
* Updated from global requirements
* Add release-note about docs
* Update index page
* Update RELEASE\_NOTES
* Update docs theme configuration
* Update sitemap tests
* [autohelp] Update opt types
* [autohelp] Return options as dicts instead of lists
* Updated from global requirements
* Remove swift tooling
* Actually skip 'update' when flagmapping are disabled
* option.help can be None
* [cli-ref] add API version for cinder explicitly
* Add missing doc for dump in autohelp-wrapper
* Updated from global requirements
* Handle object type when registering runtime options in autohelp
* Allow overriding of openstack-manuals dir
* trivial: Remove 'pass\_through'
* Make flagmapping optional
* Separate option formatting
* Index options by group too
* Simplify the format of paragraphs
* Include 'deprecation' as a flag
* Remove unnecessary parameter
* [cli-ref] add line break to avoid lengthy line
* extract\_swift\_flags: Remove '--from' argument
* extract\_swift\_flags: Remove 'docbook' command
* Updated from global requirements
* Updated from global requirements
* Updated from global requirements
* Update hacking

1.5.0
-----

* Update to point to launchpad openstack-doc-tools
* [cli-ref] support required arguments option
* Updated from global requirements
* [cli-ref] support aodhclient

1.4.0
-----

* Fix building of translated Install Guides on Mitaka
* [cli-ref] add gnocchi subcommands
* [cli-ref] support vitrage command
* [cli-ref] emphasize the warning
* Remove support for py33
* Typo fix: occured => occurred
* [cli-ref] fix insufficient markups
* Remove :option:
* Add py35 to trove classifier
* [cli-ref] Remove Block Storage API V1 note
* [cli-ref] Remove Image API V1

1.3.0
-----

* Updated from global requirements
* [cli-reference] remove unnecessary subcommand list for freezer
* Fix TypeError in autohelp.py
* Add pdf file link in build result page
* H803 have been deprecated
* Add Constraints support
* Updated from global requirements
* Skip docutils version that errors on remote images
* [cli-ref] unlink the openstack command
* Show team and repo badges on README
* Make hooks module import optional
* [config-ref] Update README for RHEL/CentOS; diff\_branches for Ocata
* PDF support using --pdf option
* [cli-ref] add project name with service name
* Remove docbook
* Link to Contributor Guide instead of wiki
* doc-tools-check-languages: Output NEWREV
* Only build debconf if it exists
* Add error check for doc-tools-check-languages

1.2.1
-----

* Fix doc-tools-check-languages
* Properly pass arguments for language building
* Gen autogenerate\_config\_docs/README.rst
* Typo mistake
* [config-ref] fix pattern matching for bullet list
* [config-ref] remove unnecessary template files
* Updated from global requirements
* [cli-reference] remove sahara CLI support
* Updated from global requirements
* Don't include openstack/common in flake8 exclude list
* Updated from global requirements
* Add prefix "$" for command examples
* [config-ref] support URIOpt/HostnameOpt to auto config doc tool
* [config-ref] support IPOpt into auto config doc tool
* Enable release notes translation
* Mitaka is an old release now
* Improve the README file of the sitemap generator
* Move SitemapItem class into generator.spiders.sitemap\_file
* Updated from global requirements
* [config-ref] Remove heading and trailing blanks from help
* Remove unnecessary white space
* Update flake8 ignore list
* Change assertTrue(isinstance()) by optimal assert
* Move release notes to be handled by reno

1.2.0
-----

* [config-ref] update service names for diff branches
* Updated from global requirements
* Updated from global requirements
* [cli-ref] cleanup osc cli reference tools
* Increase hacking version
* Remove Babel requirement

1.1.0
-----

* Add root-marker file to translated manuals
* [cli-ref] remove deprecated Block Storage API v1
* [cli-ref] unsupport the openstack command
* [cli-ref] support Backup, Restore, and DR service

1.0.1
-----

* Fix install-guide draft translated publishing
* [cli-ref] support NFV Orchestration service

1.0.0
-----

* [cli-reference] use Image API v2 as default
* [cli-reference] add gnocchi subcommands
* Updated from global requirements
* doc-tools unit tests
* [config-ref] support cfg.PortOpt type by the generation tool
* [cli-ref] add rmdir to cleanup working directory
* [config-ref] skip options marked as disable
* [config-ref] add murano and senlin
* [cli-ref] split glance\_property\_keys.rst into another file
* [cli-ref] update warning message
* Remove Icehouse and Juno content from sitemap
* [cli-reference] add python-watcherclient
* [cli-ref] Concatenate the command options with '-'
* [www-index] skip unnecessary 'samples' directory
* Updated from global requirements
* [cli-ref] change service names to official names
* Updated from global requirements
* Updated from global requirements
* [cli-ref] add work around for long command option
* [cli-ref] Use Identity API v3 instead of v2
* Updated from global requirements
* Updating README with additional necessary packages
* Changing 'raise e' to 'raise' to prevent exception masking
* [cli-reference] remove oslo.log installation
* [cli-reference] Remove Cue project
* Allow for config option flags
* Updated from global requirements
* [config-ref] add README for diff\_branches.py
* [config-ref] remove unnecessary RST markup
* Factor out Install Guide for Debian with debconf
* Remove common directory switcher
* Allow bulleted lists in config reference
* [cli-ref] Use Image API v2 at first
* Remove openstack-doc-test
* Update Magnum service name and mission statement
* Updated from global requirements
* Updated from global requirements
* Remove build\_environment from .gitignore
* Remove DocBook XML translation support
* Remove glossary handling
* Updated from global requirements
* Add docs environment
* Remove executable privilege of doc/source/conf.py
* [cli-ref] add heat deprecation note
* use environment variables for GITPROJ and GITBASE
* Add cliff-tablib to requirements.txt
* safe get deprecated\_reason
* [cli-ref] Remove keystone CLI support
* [cli-ref] Added support for 'help' and 'version'
* [cli-ref] Add support for multiple clients
* [cli-ref] Fix non-deprecated cmds being skipped
* [cli-ref] Fix wrong delim splitting subcommands
* [cli-ref] Support DeprecationWarning for version number
* Updated from global requirements
* [cli-ref] Remove work around for checkniceness
* Updated from global requirements
* [README] Update the content for mitaka
* [User Guides] Remove Admin User Guide from Tools build
* [sitemap] mark liberty as an old release
* [cli-ref] Add osprofiler installation for --profile option
* [cli-ref] Change heading level for subcommands from 2 to 3
* [cli-ref] Switch Block Storage API usage order

0.34.0
------

* Do not publish translated Debian Guide
* Make diff\_branches.py work again
* autohelp: add zaqar to the default projects
* Fix a typo in autogenerate\_config\_docs/README.rst
* Remove parallel building
* Better identify deprecated configuration options
* Provide a more human identifable option data type
* Catch sqlalchemy.exc.InvalidRequestError exception
* Updated prerequisite packages for ironic & swift
* Remove parallel building
* Keep py3.X compatibility for urllib
* [nova-cli-ref] Adjust long line for check niceness
* Note to add 'jinja2' and 'markupsafe' to requirements
* Change help category markup
* Updated from global requirements
* Remove markdown script
* [autohelp] Remove oslo.incubator installation
* Change Git message got cli reference update
* Use pep8 instead of linters
* Add option pattern to cli ref tool

0.33.0
------

* Updated from global requirements
* Add switcher for common directory
* Remove tuskar handling
* Fix two word spellings
* Add Topic tag in cli-reference generated script
* autohelp: fix poor behavior of \_sanitize\_default
* autohelp: avoid duplicated overriden entries
* [sitemap] do not add empty URLs to the list of start URLs
* Rename pep8 to linters test
* Remove unused requirements
* Address pep8 warning at doc-tools-check-languages
* Address pep8 warning at markdown-docbook.sh
* Address pep8 warning at autohelp-wrapper
* Updated from global requirements
* Update CLI Reference generation tool for RST
* [sitemap] set higher priority for files of the current release
* Move the config items in the manuals repository
* tox: remove the pypy env
* autohelp: remove old files
* \`autohelp update\` can create the flags file
* Add Zaqar configuration options hook
* Updated from global requirements
* autohelp-wrapper: remove leftover "fi"
* Skip non-existing test-requirements with pip install
* Install optional cliff dependency
* Update osc plugins
* Add testrepository to test-requirements
* py33 is no longer supported by Infra's CI
* Put py34 first in the env order of tox
* [autohelp] Update the component names
* [autohelp] config-ref-rst moves to config-reference
* [autohelp] display information on import error
* autohelp: add keystone modules to ignore list
* Update python-xxxclient for python-openstackclient
* Mark Block Storage API v1 as deprecate
* Set the bug project to i18n for the translated docs
* Add additional openstack client plugins
* [diff\_branches] Handle empty values in RST tables
* Updated from global requirements
* [autohelp] Avoid long lines in templates
* [diff\_branches] Projects can be passed as arguments
* Insert property keys section into glance chapter
* [autohelp] allow overrides of sections
* Simply rmdir usage with --ignore-fail-on-non-empty
* [autohelp] Simple neutron handling
* Update autohelp template for Config Reference
* Update command line list on clients.yaml
* Add -W to sphinx invocation for release-notes build
* [autohelp] misc fixes
* Improve index page layout
* [autohelp] Add table label for RST reference
* autohelp: avoid help strings on multiple lines
* Add python-openstackclient required plugin package
* Updated from global requirements
* Fix for getting glance command list
* Update README for autogenerate\_config\_docs
* diff\_branches: fix deprecated opts listing
* diff\_branches: master is Mitaka
* autohelp: workaround for empty values in RST literals
* Reno: Remove unreleased and merge with index
* autohelp: add aodh to the projects list

0.32.0
------

* autohelp.py: switch to jinja templates
* [autohelp] Move ignored modules list to a file
* swift flags: read from RST
* Do not publish doctrees for translated guides
* Rework install guide translation build tool
* Update RELEASE Notes
* Add Reno entry for RST autohelp
* Update virtualenv, pip and git existent check in cli-ref tool
* Fix cli-package name check
* Repo change for networking-bagpipe-l2
* Add bash-completion/complete selection for command list parsing
* extract\_swift\_flags: add RST support
* [autohelp] Migrate the swift script to jinja
* diff\_branches: add RST support
* diff\_branches: use jinja templates to create the files
* Automatically generate content for master
* Remove now obsolete placeholder
* Updated from global requirements
* autohelp: properly sanitize paths
* commands: add a stderr redirection
* Use a more pythonic syntax
* autohelp: keep the projects names sorted
* Add reno for release-notes
* Add kuryr and dragonflow to neutron config ref
* Update autohelp-wrapper to support RST output
* autohelp: use the same extension for configs
* Removed a virtual build and test environment based on Vagrant
* Add manila for config ref list
* Remove openstack-autohelp from setup.cfg
* Update kemptech lbaas package requirements for config reference
* Updated from global requirements
* Update networking-cisco plugin requirements
* Add config reference autogeneration support for neutron-plugins
* config reference for neutron (networking-zvm)
* Sorting in config-reference autogeneration list for neutron
* Stackforge retirement..
* Update config reference package list for neutron
* [sitemap] introduce attribute to define start URLs
* [sitemap] respect the robots.txt policies
* [sitemap] remove deprecated URL from settings
* [sitemap] if last-modified not set in header use current date
* commands: set extra\_params to '' if value is None
* Sync doc-tools-build-rst with openstack-manuals
* Add openstacksdk to draft builds
* Change in openstack CLI keystone-warning message
* doc-tools: Build in parallel with NUMBER\_OF\_CORES processes
* Do not publish doctrees
* [os\_doc\_tools] sync clients.yaml with governance repository
* [os\_doc\_tools] add cli-reference generation for cloudkitty
* [os\_doc\_tools] fix cli-reference generation for gnocchiclient
* Remove duplicate manila entry from clients.yaml
* diff\_branches: Add support for manila
* Add verbose options for Config Ref generation tool
* Add neutron plugin modules for Config Reference autogen
* Increase visibility of the warning in autodoc files
* Add https to requirements/neutron-master.txt

0.31.0
------

* Update Release notes for 0.31.0
* Update doc-tools-build-rst
* Add python-gnocchiclient entry for CLI-generation
* Added new commands for trove-manage
* [sitemap] increase the DOWNLOAD\_WARNSIZE
* [sitemap] resolve remaining ScrapyDeprecationWarning exceptions
* [sitemap] add a requirements file
* Fix generated commit message for python-openstackclient
* Fix oversight in patch 221559
* Fix alphabetical order in hooks.py
* Generate openstackclient subcommands from setting identity API to v3
* Add hook to get Aodh config options
* Remove MagnetoDB from clients.yaml file
* Add missing comma in output text
* Updated from global requirements
* [autohelp] Disable the networking-lenovo repository
* Add new neutron drivers to requirements
* autohelp: update the neutron powervm repository URL
* Add supported modules for config ref generator
* autohelp: add an exception for the cinder wsgi script
* openstack-auto-commands: fix issues with python-glanceclient 1.0.0
* Updated from global requirements
* Fix XML file generation error for cli-reference in murano case
* Updated from global requirements
* Add doc-tools-build-rst

0.30.1
------

* Fix Install Guide builds
* Fix mis-option identification for doc-tools-update-cli-reference

0.30.0
------

* Handle translation of Install Guide and FirstApp
* autohelp: add oslo.service to the list of extensions
* Remove special handling for user-guides
* [sitemap] transform README from Markdown to reStructuredText
* [sitemap] resolve several ScrapyDeprecationWarning exceptions
* [autohelp] document required development packages
* [diff\_branches] add note when no options are {new,updated,deprecated}
* Updates to make diff\_branches work again
* Updated from global requirements
* [openstack-doc-tools] fix one typo
* Updated from global requirements
* autohelp: add oslo.cache as extension
* update the neutron requirements for liberty
* autohelp: support reading options from multiple repos
* autohelp.py: remove the oslo.i18n hack
* Remove the heat-ref related tools
* Python 3: Fix os\_doc\_tools/commands.py
* Improve python 3 compatibility
* Drop python 2.6 workaround
* Improve python 3 compatibility for doctest.py
* Stop specifying requirements.txt in tox.ini
* Updated from global requirements
* autohelp: fix a typo
* diff\_branches: master is Liberty
* Always build index for checkbuild
* Support 'murano' in openstack-auto-commands
* Updated from global requirements

0.29.1
------

* Add --use-first option to msgcat

0.29.0
------

* Fix up README to work with the release tools
* Update RELEASE\_NOTES.rst
* Handle common-rst pot file
* Use python2.7 for doc-tools-update-cli-reference
* Add missing requirement PyYAML
* autohelp: use correct option names from extensions
* let the autohelp\_wrapper use local repos
* autohelp: generate rst tables
* autohelp: remove rootwrap discovery code
* Translation updates

0.28.0
------

* Fix RST languages
* diff\_branches: improve handling of deprecated options
* Sort entries in index.html

0.27.0
------

* openstack-doc-test: Fix index.html
* Updated from global requirements
* autohelp: load oslo.middleware options
* Do no build Debian Install Guide by default

0.26.0
------

* Further improvements for openstack-auto-commands
* Improve openstack-auto-commands
* Fix translation building and publishing

0.25
----

* Autohelp: update the scripts for the juno/kilo diff
* autohelp: updated to handle juno
* Remove venv tools
* Drop use of 'oslo' namespace package
* extract\_swift\_flags: strip help strings
* autohelp: updated to include vmware-nsx options
* autohelp: add a neutron hook
* Update RELEASE\_NOTES.rst for the 0.25 release
* autohelp: lookup options in more oslo libraries
* Use parameter instead of option
* autohelp-wrapper: reorganise project dependencies
* autohelp-wrapper: build one venv per project
* Handle RST languages and drafts
* Remove /draft from sitemap
* Capitalize project names correctly

0.24
----

* Update RELEASE Notes for 0.24 release
* Update README.rst notes for Neutron project due to recent vendor decomposition
* Handle User Guides
* swift flag: handle XML in help strings
* autohelp: strip help strings on dump too
* autohelp: update the ignored modules list
* [commands] add a deprecation note for python-keystoneclient
* [commands] extract correct version string when client is deprecated
* Updated from global requirements
* Add wrapper script to update CLI references
* Handle SPECIAL\_BOOKs in doc-tools-check-languages
* Updated from global requirements
* autohelp: fix the nova\_spice hook on juno
* Rework the autohelp serialization of options
* [autogenerate\_config\_docs] use filename tags to mark filenames
* [commands] use --os-auth-type token only for python-openstackclient
* [commands] fix generator for latest python-openstackclient
* Use yaml.safe\_load() instead of yaml.load()

0.23
----

* Build index even for RST only change
* Handle RST files
* autohelp: don't ignore cmd/ folders

0.22
----

* Add option --ignore-book
* Update sitemap generator
* autohelp: don't specify encoding in the base xml
* Include ironic in the autohelp default projects
* Handle possible keystone duplicated opts
* Add a hook for nova.cmd.spicehtml5proxy
* Update to hacking 0.10
* Adds niceness check to avoid unwanted unicode charaters
* Updated from global requirements
* Ignore <option> tags in generatepot
* Fix xml tagging for non-swift config tables
* Add <option> tags to options in autogenerateconfig
* [build-environment] add repository ha-guide and update README file

0.21.1
------

* Add final newline to file formatting

0.21
----

* Update RELEASE\_NOTES
* Change config changes generator script
* Add new parameter --url-exception to not check URLs for reachability
* Workflow documentation is now in infra-manual
* Add ironic to the list of supported commands in os\_doc\_tools.commands
* Add sahara to the list of supported commands in os\_doc\_tools.commands
* Updated from global requirements
* Updated from global requirements
* dn2osdbk: Add a new line at the end of index pages
* dn2osdbk: Fix string template
* Added dependencies for lxml on Fedora
* Document sahara common auth options
* Fixed the command to install maven on Fedora
* Autohelp: sanitize the value during discovery
* master is now Kilo
* diff\_branches: capitalize the release name
* Updated from global requirements
* Use jsoncheck in doctest
* Cap maximal cyclomatic complexity
* Split out some functions

0.20
----

* Updated from global requirements
* dn2osdbk: handle internal references
* Remove extraneous vim editor configuration comments
* Remove @author tags from copyright statements
* Fix extract\_swift\_flags.py
* autohelp: Remove trailing spaces from help strings
* Ensure a newline (\n) at the end of a file
* Don't fail if glance\_store is not available
* Mark openstack-doc-tools as being a universal wheel
* Updated from global requirements
* Typo "Initialze" instead of "Initialize"
* Add a hook to load glance\_store options

0.19
----

* Document cinderclient v2 as well
* Document glance v2 commands
* Generate subcommands for python-openstackclient
* commands: add 'openstack' to the list of clients
* Improve output of CLI documentation
* diff\_branches: improve the generated title
* Use ironic's bash-completion for CLI commands
* diff\_branches: add the project sources in sys.path
* Rework translation only logic
* wrapper: clean the source dir before a checkout
* Print only xml files for --print-unused-files
* Fix git checkout
* Fix handling of arguments in autohelp-wrapper
* Document openstack client
* Provide the hotref sphinx extension
* autohelp: add a module blacklisting mechanism
* Warn against sorting requirements files
* Work toward Python 3.4 support and testing
* Add fast option to autohelp-wrapper
* Allow comments in flag and headers
* Parse shared.headers for autohelp
* dn2osdbk: support the :command: inline markup
* Update the autohelp readme
* autohelp-wrapper: support the create subcommand
* autohelp: Set table names
* Improve the autohelp scripts
* Handle translations, update RELEASE NOTES
* Update sanitizer to handle '/sources' in pybasedir
* Fix output/doc strings that assume only XML files
* Updated from global requirements
* jsoncheck: set exit status if exception occured
* Fix issues found by bashate and include in gating
* Run doc8 as part of pep8 test

0.18.1
------

* Fix doc-tools-check-language

0.18
----

* It's isfile
* jsoncheck: use ValueError to pass errors to outside callers
* Handle exceptions of handle\_options
* Add a link to the static index of generated WWW pages
* Remove CLI parameters and import/initialize logging
* Number of errors should be returned
* Add requirements required by openstack.common.log
* Do not abort on first failure
* Use which instead of type to check if a binary exists
* Remove publish\_www and simplify www\_touched
* A virtual building and testing environment using Vagrant
* Import module log and needed dependencies from oslo-incubator
* Add check for links
* jsoncheck: indent strings only when printing them
* Print run time
* jsoncheck: fix \_indent\_note for pre-formatted strings
* jsoncheck: fix handling of formatting argument
* Add missing shift to make language for loop workable
* Make doc-tools-check-languages configurable
* Fix method name of verify\_section\_tags\_have\_xmid
* Import doc-tools-check-languages and improve it
* Support files as source for dn2osdbk
* Don't always build the hot-guide
* Fix bashate issue E003
* Replace usage of readlines()
* autohelp: make sure that oslo.i18n is setup
* Add sahara to the autohelp supported projects
* Move release notes into a separate file
* Updated from global requirements

0.17
----

* README update for the 0.17 release
* Provide openstack-dn2osdbk
* sanitizer: handle values ending with spaces
* Adds Python as a prerequisite to readme
* Updated from global requirements
* Add API for sahara description
* Removed trailing whitespace from help output
* Bump hacking to version 0.9.2
* Don't use oslo's \_sanitize\_default
* Updated from global requirements
* Add requirement pbr in documentation
* Fix wrong variable name in autogenerate\_config\_docs documentation
* Transformed README file to RST and included missing URLs
* Rewrite return statement in method use\_help\_flag
* Update README.rst
* Update XML root elements
* Added support for \*-manage CLI doc generation
* Add 0.17 marker to README.rst
* Correctly handle CTRL+C in openstack-doc-test
* Do not set xlink namespace for links
* Handle errors when parsing XML files using Expat

0.16.1
------

* Fix includes for rackbook.rng

0.16
----

* Update generate-doc-book entity handling
* Use lxml to handle the XML data
* autohelp: import oslo extensions only if needed
* autohelp-wrapper: fix the extract\_swift\_flags call
* Improve sitemap generation
* Remove client-requirements.txt
* Sync rackbook.rng with clouddoc-maven-plugin
* Update README.rst with recent changes
* Update README
* diff\_branches: don't generate empty tables
* Improve the output format for option names
* Support swift in diff\_branches.py
* extract\_swift\_flags.py: implement a 'dump' argument
* Add a public interface to jsoncheck.py
* Updated from global requirements
* Fix the target argument
* jsoncheck: make formatting check optional
* Include swift in the autohelp-wrapper script
* Provide CLI options for extract\_swift\_flags.py
* Don't check the autohelp-wrapper output dirs
* Bump hacking to 0.9.x series
* Provide a script to gerenate options changes
* A script to prettify HTML and XML syntax
* remove jsoncheck's check\_format()
* add exceptions check to is\_testable\_{,\_xml}\_file
* jsoncheck: split process\_one\_file from main
* rename is\_xml{,like}: is\_testable{,\_xml}\_file
* make use of is\_xml()
* remove redundant check from find\_affected\_books
* commands.py: handle missing command
* Improve help text for commands.py
* is\_xml{,\_like} handle paths, not filenames
* Ignore the generated sitemap
* Add a wrapper to simplify the autohelp.py usage
* cleaning up index.rst file
* script to generate the sitemap.xml for docs.openstack.org
* make sure that source is not a directory
* Updated from global requirements
* Fix 0.16/0.15 notes
* Fix README
* Fix handling of ignored\_dirs

0.15
----

* Fix ENTITY bug with xml2po
* Remove Docbook conversion in tox for HA Guide
* Add RETF to README.rst
* Update for swift 2.1.0
* Special case entity files
* Show git info
* rewrote a branch in two methods to increase readability
* use /usr/bin/env python instead of /usr/bin/python
* remove definitions of Python Source Code Encoding

0.14
----

* Fix for building identity-api
* Update branch handling
* Fix setup.cfg for rename of main in doctest
* Add pylint target for testing
* Fix some more pylint warnings
* script to apply RETF rules onto a set of files
* Fix error in build-ha-guide.sh
* Remove some pylint warnings
* fixed several pep8 issues
* Do not special case publish flag for www only change
* Only print properties in verbose mode
* fixed pep8 issues in doc/source/conf.py
* Refactor the generation of docbook data
* Fix generation of ha localized guide
* autohelp.py: update the paramters handling
* Don't use a common file
* Display more information with -v
* Add new script jsoncheck.py
* Warn about usage of non-breaking space
* auto-commands: Improve swift display
* Updated from global requirements
* Place </screen> on proper line, fix swift usage
* Update README
* extract\_swift\_flags: Improve the output
* extract\_swift\_flags: fix the tables parsing

0.13
----

* Handle translations for api-site
* Update client-requirements.txt
* Remove compatibility names

0.12
----

* Improve api-site handling for openstack-doc-test
* Discover keystone\_authtoken options

0.11
----

* Keystone 0.8 is recent
* Handle www pages properly when publishing
* Use option.dest instead of option.name
* Update versions of clients
* Updated from global requirements
* autohelp: add a hook mechanism
* Generate docs for projects' rootwrap.conf file
* Update Service spelling for commands
* Fix README formatting

0.10
----

* Update for keystone client 0.7.1
* Handle api-ref-guides publishing
* Minor README.md update
* Fix ListOpt output
* Remove code for flapmappings file compatibility
* Minor cleanup
* Fix sorting of flagmapping files
* autohelp.py: generate an ID for the tables
* Add period at end of help string
* Fix generation of command usage (--help)
* Handle options not registered on module import
* Add client-requirements.txt file
* Fix computing of the package name from the git repo
* Handle CLI commands for ironic and sahara
* Stop using generator.\_list\_opts; use cfg.CONF instead

0.9
---

* Add client version number
* Update README for 0.9 release
* Sanitize file paths
* autohelp.py: Fix sanitizing of modules paths values
* autogenerate\_config\_docs: use a venv in README example
* Add new option --build-file-exception to openstack-doc-test
* autohelp.py: add a --output option
* Don't fail if an old mapping file is invalid
* Don't fail on DuplicateOptError
* autogenerate\_config\_docs: fix computing of relative path
* Fix generation of markdown chapters
* Don't descend into publish-docs directory
* Validate JSON files
* Do not check for xml:ids in wadl resources

0.8.2
-----

* Fix error reporting of doctest and parallel builds
* Updated from global requirements

0.8.1
-----

* Initialize output properly
* Fix index generation for api-ref
* Use pandoc templates to set root element, xml:id, and default title
* Fix building of identity-api-v3

0.8
---

* Fix building of image-api-2 etc
* Improve cli output
* Fix markdown of autogenerate\_config\_docs/README.md
* Typo in autogenerate\_config\_docs working example

0.7.1
-----

* Fix building of image-api-v2
* Prepare for 0.7.1 release
* Improve robustness with localbuilding
* Fix niceness and syntax wadl checks

0.7
---

* Fix typo, add new line - for index.html file
* Create index.html file to find books more easily
* Also copy atom.xml
* Allow setting of publish directory
* Rename Openstack to OpenStack
* Do not install internal scripts in /usr/bin
* Remove empty path elements when constructing modname
* Remove tox locale overrides
* Remove obsolete option --exceptions-file
* Encode language in build log file
* Generate a log file for each built book
* Fix gating of identity and image apis

0.6
---

* Start adding 0.6 release notes
* Add a suitable default for '-b'
* Avoid putting autogenerate\_config\_docs/.gitignore into sdist
* Honor install prefix
* Check that mvn is installed and abort if not

0.5
---

* Handle translations
* Copy all generated books to common path
* Generate chapters instead of sections for commands
* Verify that resources have xml:id
* Improve docbook format for cli commands
* Remove default exceptions

0.4
---

* Add tool to document cli tools
* Rename autogenerate-config-docs to autogenerate\_config\_docs
* Re-add support for multiple categories per option
* Sort option names by group in autohelp log output
* Use '.' not '/' when comparing module names
* Resolve pep8 comments
* Switch to / for group delimieter in flagmappings files
* Add group information to autohelp.py DocBook output
* Add option --exceptions-file
* Minor cleanup of test-requirements and tox
* Sanitize option defaults in autogenerated config reference
* Sync with global requirements
* Reworked autohelp to support dup option names in different groups
* Updates root README.rst to contain release notes

0.3
---

* Validate further XML files
* Fix path in generatedocbook
* Fix misspellings
* Display name and version at each run

0.2
---

* Add parameter --ignore-dir
* Do not download RNG Schema, instead use local copies
* Add .mailmap
* Do not abort on invalid XML
* Fixes for building
* Use sphinx for documentation of openstack-doc-tools
* Require hacking for additional checks
* Do not check directories starting with "."
* Document lxml requirement
* Add HACKING.rst

0.1
---

* Version handling
* Import venv setup from oslo-incubator
* Add empty autogenerate-config-docs/\_\_init\_\_.py
* Add webpage as audience for profiling
* More robust book building for api-site
* Explicitely add license information to code files
* Enhance .gitignore list
* Add test-requirements.txt
* Build markdown documents
* Make markdown-docbook.sh more robust
* Package markdown-docbook.sh
* Import markdown-docbook.sh from config
* Extend niceness check to handle tabs as well
* Initial support for gating api-site
* Autogenerate config tools: Allow line wrapping
* Add HACKING.rst
* Fix issues found by flake8
* Add tox.ini
* Remove flagmappings
* Rework repository to make it an installable python package
* Adds multiple group support for config options in autohelp.py
* Add LICENSE and README.rst
* Use th for table headers
* Sync generatedocbook with operations-guide
* Add .gitignore file
* Add .gitreview
* Update nova flagmappings for libvirt group
* Move libvirt flags to libvirt group (cont.)
* Renamed docker\_registry\_default\_port flag
* Handle audience profiling in test.py
* Removed references to unused  libvirt\_ovs\_bridge flag
* Ensure all "os" values are valid/recognized
* test.py: Improve output
* Detect conflicting profiling attributes
* Adding guidance on software installation
* Fix typo on error message
* Cleanup for test.py
* VMware: Using auto-gen table in cinder driver doc
* Build separate Install Guides for Ubuntu and Debian
* Updates sitemap.xml for havana release links
* Add sles for os profiling
* Fix behaviour with removed files
* Move coraid\_esm\_address to coraid table
* Add debian to build commands for Install Guide
* Fix test.py invocation, fix deletions check, cleanup
* Remove training-guide from translated guides
* Fix path used in generatepot
* Updates conf reference for neutron ml2 plugin
* Search all dependencies to check which books to build
* Remove old basic install pom file
* Improve output of test.py
* Handle FILE\_EXCEPTIONS properly
* Fix cleanup tools
* Improve output of test.py
* Remove tools/validate.py
* Remove bk001-ch003-associate-general.xml from blacklist
* Update conf option tables for cinder
* Handle changes of tools or pom.xml, ignore doc/pom.xml
* Rebuild HA Guide if files modified
* Build all Install Guides and HA Guide in gates
* Improve checking for modified files
* Have test.py run all checks if no arguments given
* It's test.py --check-deletions
* Fix book building
* Improve validation tools
* Possible fix for FontTriplet errors during heavy load
* Autogenerate neutron tables
* Improve validation of removed files
* Fix validate.py and test.py traversals
* Modularize cinder tables and use them in Config Guide
* Fix test.py
* Handle imagedata in test.py and validate.py
* Update glance autogenerated tables
* Update cinder flags with autogenerate tools
* Update common/tables/nova\*
* Check also for non-xml include files
* Updated nova config tables after feature freeze
* Update tools/test.py for directory rename
* Improve validate output
* Fix validate.py and print process message
* Do not build all books if only www/ is changed
* Adjust validate.py for flattened directory structure
* Update autogenerate tools for new directory struct
* Handle removed files in tools/validate.py
* Fix output of tools/validate.py --force
* modication including sets
* Make swift config tables the source of truth
* Swift work for config reference
* Update DocBook validating schema to 5.1CR1
* Don't descent into target dirs
* Add file name to whitespace information
* Add a tiny bit more verbosity to validate.py
* added parameters to control the behaviour
* added scripts to cleanup spaces in XML files
* take care of books with sources in subdirectories
* introduced force to validate and build everything
* print the relative path in list of modified files
* build several books in parallel
* build every book only once
* strip spaces before writing the files
* Update flagmappings
* make validation workable inside book directories
* Change whitespace check to be info only
* reduced verbosity of validation script
* validate modified files and build affected books
* Add Autogenerate-config-doc code to tools
* verify that no unnecessary whitespaces are used
* validate.py variable changes
* do not exit after first invalid file
* Attempt to build all books
* The docbookxi.rng schema moved to oasis-open.org
* Validate presence of xml:id in section
* Update generatedocbook
* Add slicing tool to the master branch
* Fix XML schema validation failures
* Add script to validate files are valid DocBook
* Remove unused tools/rfc.sh
* Add rfc.sh to help with gerrit workflow
