Hawkmoth

-----------------

:Date: 2021-01-29

Added
~~~~~

* Retroactively written changelog
* Helper and documentation for using Hawkmoth on Read the Docs

Changed
~~~~~~~

* Switched to semantic versioning

Fixed
~~~~~

* Array member documentation in structs and unions
* Function pointer documentation
* Clang diagnostics without a file; e.g. on command-line parameter errors

---------------

:Date: 2020-12-30

Added
~~~~~

* Support for Sphinx v3.0 and later
* Use new Sphinx features for macro, struct, union, enum and enumerator
documentation
* Detailed installation instructions
* Simple Dockerfile for testing
* requirements.txt and virtual environment helper

Changed
~~~~~~~

* General documentation improvements
* Fallback code for documentation builds without Hawkmoth

Removed
~~~~~~~

* Sphinx v1.x and v2.x support

Fixed
~~~~~

* Array variable documentation

---------------

:Date: 2020-01-25

Changed
~~~~~~~

* Bumped development status to beta
* Improved macro documentation test cases
* Improved function documentation test cases

Deprecated
~~~~~~~~~~

* Last version to support Sphinx versions v1.x and v2.x.

Fixed
~~~~~

* Documentation of non-prototyped functions

---------------

:Date: 2019-06-08

Added
~~~~~

* Support for propagating Clang diagnostics to Sphinx

Changed
~~~~~~~

* Rename hawkmoth parser module
* Testing updates

---------------

:Date: 2019-01-29

Changed
~~~~~~~

* Python packaging update
* Testing updates

---------------

:Date: 2019-01-26

Added
~~~~~

* Python packaging
* Support for variadic function documentation
* Support for variadic macro documentation

Changed
~~~~~~~

* Parser refactoring
* Testing overhaul, switch to sphinx_testing

.. _master: https://github.com/jnikula/hawkmoth/compare/v0.19.0..master
.. _0.19.0: https://github.com/jnikula/hawkmoth/compare/v0.18.0..v0.19.0
.. _0.18.0: https://github.com/jnikula/hawkmoth/compare/v0.17.0..v0.18.0
.. _0.17.0: https://github.com/jnikula/hawkmoth/compare/v0.16.0..v0.17.0
.. _0.16.0: https://github.com/jnikula/hawkmoth/compare/v0.15.0..v0.16.0
.. _0.15.0: https://github.com/jnikula/hawkmoth/compare/v0.14.0..v0.15.0
.. _0.14.0: https://github.com/jnikula/hawkmoth/compare/v0.13.0..v0.14.0
.. _0.13.0: https://github.com/jnikula/hawkmoth/compare/v0.12.0..v0.13.0
.. _0.12.0: https://github.com/jnikula/hawkmoth/compare/v0.11.0..v0.12.0
.. _0.11.0: https://github.com/jnikula/hawkmoth/compare/v0.10.0..v0.11.0
.. _0.10.0: https://github.com/jnikula/hawkmoth/compare/v0.9.0..v0.10.0
.. _0.9.0: https://github.com/jnikula/hawkmoth/compare/v0.8.0..v0.9.0
.. _0.8.0: https://github.com/jnikula/hawkmoth/compare/v0.7.0..v0.8.0
.. _0.7.0: https://github.com/jnikula/hawkmoth/compare/v0.6..v0.7.0
.. _0.6: https://github.com/jnikula/hawkmoth/compare/v0.5..v0.6
.. _0.5: https://github.com/jnikula/hawkmoth/compare/v0.4..v0.5
.. _0.4: https://github.com/jnikula/hawkmoth/compare/v0.3..v0.4
.. _0.3: https://github.com/jnikula/hawkmoth/compare/v0.2..v0.3
.. _0.2: https://github.com/jnikula/hawkmoth/compare/1105c87c1078..v0.2