CHANGES
=======

* Deprecate version attribute
* tox: Use new constraints option
* typing: Remove unnecessary type: ignore
* Update packaging configuration

3.2.0
-----

* ruff: Configure hacking as external linter
* Replace deprecated nodes.Node.traverse
* Add typing
* Add ruff
* Defer log arg parsing
* Drop workaround for python < 2.7.4
* Remove reference to tag framework
* pre-commit: Bump dependencies
* Migrate setup configuration to pyproject.toml
* Drop Python 3.9 support
* Add support to build api-ref as plain text
* Use nova bindep file in os-api-ref-nova-src job

3.1.0
-----

* Run pyupgrade to clean up Python 2 syntaxes
* Bump pre-commit config

3.0.1
-----

* Mark sphinx extensions thread safe
* Move to bootstrap5
* Series of job fixes

3.0.0
-----

* remove unicode prefix from code
* Fix the 'No such file or directory' error
* Remove deprecated sphinx-testing dependency
* Drop python3.6/3.7 support in testing runtime
* Update CI to use unversioned jobs template
* Add Python3 yoga unit tests

2.3.0
-----

* Fix exception logging
* tox: Don't use distutils entrypoint for coverage
* Remove six
* Drop support for Sphinx < 4.x

2.2.0
-----

* setup.cfg: Replace dashes with underscores
* Switch testing to Xena testing runtime
* Move flake8 as a pre-commit local target
* Replace 'add\_stylesheet', 'add\_javascript'
* Use TOX\_CONSTRAINTS\_FILE
* Use py3 as the default runtime for tox
* Bump py37 to py38 in tox.ini
* bump py37 to py38 in tox.ini
* Fix hacking min version to 3.0.1
* Stop install unnecessary packages when run tox -edocs
* Remove install unnecessary packages
* Adding pre-commit

2.1.0
-----

* Switch to newer openstackdocstheme version
* Remove .testr.conf
* Remove unused translation content

2.0.1
-----

* Update hacking for Python3
* Update sphinx-testing requirements to >=1.0.1

2.0.0
-----

* [ussuri][goal] Drop python 2.7 support and testing
* Use Ussuri jobs

1.6.2
-----

* Add Python 3 Train unit tests
* Add support for Sphinx v2.1
* Update Testing for Train
* Replace git.openstack.org URLs with opendev.org URLs
* Add support for Sphinx 2.0
* OpenDev Migration Patch
* trivial: Remove unused attribute

1.6.1
-----

* Generate stable targets rather than random
* Fix microversion test: handle different HTML renderings
* Update hacking version
* Remove support for py34

1.6.0
-----

* Fixing duplicate label issue
* readthedocs.io support
* Update the remained discuss email
* Change openstack-dev to openstack-discuss
* Update sphinx extension logging
* tests: Support Sphinx 1.8+
* docs: Remove broken link
* switch documentation job to new PTI
* Fix sphinx-build invocation
* import zuul job settings from project-config
* Use 'sphinx.util.logging'
* General overhaul of testing setup
* Raise warning if top-level value is not a dict
* Updated from global requirements
* Updated from global requirements
* Updated from global requirements
* Use openstackdocstheme
* Remove name from project stanza

1.5.0
-----

* Updated from global requirements
* Fix wrong links
* Update and replace http with https for doc links
* Add 'uuid' type
* Fix Zuul jobs
* Updated from global requirements
* Fix UnicodeDecodeError
* Updated from global requirements
* doc: Remove deprecated call to sphinx.util.compat
* Remove unconstraint package installation
* Clear description for max\_version field

1.4.0
-----

* Fix for sphinx 1.6.2
* Updated from global requirements
* Updated from global requirements
* Replaces yaml.load() with yaml.safe\_load()
* Update tests for more recent sphinx
* Enable warnings as errors
* Updated from global requirements
* [Fix gate]Update test requirement
* Update hacking

1.3.0
-----

* Updated from global requirements
* Delete support py33
* add file on releasing the software

1.2.0
-----

* Fix anchor link setting url bar
* detail/close button, bug #1618955
* Removes unnecessary utf-8 encoding
* Show team and repo badges on README
* Updated from global requirements
* Removes unnecessary utf-8 encoding
* Add compatibility with docutils 0.13
* Add Constraints support
* Import httplib from six to support Python 3
* Updated from global requirements
* Add test for missing path params
* microversion selector - dropdown

1.1.0
-----

* Sync with global-requirements
* Update homepage with developer documentation page
* Adds an example http-status.yaml file and updates doc
* Use beautifulsoup4 instead of bs4 in test-requirements.txt
* remove padding-top for endpoint-container
* Adds more info to the README to instruct authors
* Expand width of API Site

1.0.0
-----

* Update docs for openstackdocstheme
* openstackdocstheme integration
* Add color for COPY label
* Change Layout of Path + Sub Title

0.4.0
-----

* Added docutils to requirements
* Moved sphinx from test requirements to requirements
* Tests for invalid parameter files
* HTTP Response Code Table

0.3.0
-----

* add experimental microversion selector
* track the expanded elements in the url
* remove unused javascript code
* Add warning for invalid parameters
* Added more details to usage.rst
* Highlight parameters in path
* fix microversion parsing in parameters.yaml
* add min/max version to rest method
* simplify conf.py in tests
* add a list of tests we should have
* make testing be non parallel
* tests for parameter out of order behavior
* More unit tests
* add first basic unit test
* Trivial: fix typos in README.rst
* Colour Code HTTP Methods
* Validate in value before sorting validation
* fix docs to link the new bug tracker

0.1.1
-----

* Make the version returned by the extension be the pbr version
* Update css for version-added
* Add parsing and output of max\_version
* Remove errant ";" from the "expand\_all" detection

0.1.0
-----

* make unsorted parameters lists warnings
* add section on warnings
* document parameters.yaml and rest\_expand\_all
* partial documentation on rest\_parameters
* update usage for rest\_method
* further enhance documentation
* Update README
* trim test-requirements.txt
* Import the sphinx extension from nova
* remove constraints, we're not going to use that
* Initial Cookiecutter Commit
* Added .gitreview
