Hawkmoth

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

:Date: 2021-05-21

Added
~~~~~

* Helper for discovering and configuring system include path
* Transform functionality for comment conversion

Changed
~~~~~~~

* Extension ``cautodoc_clang`` configuration option must now be a Python list
* Directive ``clang`` option now extends instead of overrides ``cautodoc_clang``
* Bumped Python dependency requirement to v3.6 for f-strings
* Switched to pytest for testing
* Switched to static packaging metadata
* Deprecated compat functionality in favour of transformations

Fixed
~~~~~

* Array function parameter documentation
* Function pointers with qualifiers such as const

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

: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