Version 1.4.0

Removed

• Support for python 3.8
• Support for Sphinx 3
• Support for Clang 6 through Clang 10

Version 1.3.0

Added

• Support for Sphinx 7

Removed

• Support for python 3.7

Version 1.2.2

Fixed

• Failed parsing of enumerators which were defined based on macros #174

Version 1.2.1

Fixed

• Regression for processing anonymous structs in versions of Clang prior to
  Clang 16. #166

Version 1.2.0

Added

• Support for Clang 16. Clang 16 changed the way anonymous constructs are
  represented when walking the AST. These differences are now accounted for.

Version 1.1.1

Fixed

• Packaging
  • Incorrectly pinned Sphinx, Clang and BeautifulSoup4
  • Was missing sphinx-c-apidoc entry point

v1.1.0

Added

• Support for Sphinx 5

This release also formalized the minimum supported versions and plan for deprecating dependencies. The current goal is to maintain dependency compatibility for 5 years.

v1.0.0

Added

• Dual licensing with MIT license.
• Support for global compilation args. Compilation args can now be specified with the c_autodoc_compilation_args configuration value.

Fixes

• Fix parsing of multi-paragraph function documentation that used doxygen style markup. Previously multi-paragraph function documentation which used doxygen style markup would get merged in to one paragraph. Now the multi-paragraph nature is preserved.

v0.4.0

Changed

• Undocumented constructs are no longer added to the documentation by default.
  To maintain previous behavior add :undoc-members: to the project's
  autodoc_default_options_.

Added

• :undoc-members: and :no-undoc-members: option for the autocmodule
  directive. This option set allows for controlling the listing of undocumented
  constructs. The default is to not list undocumented constructs.

Fixes

• Fix file level variables with unknown types. Previously variables with
  unknown types would cause an error in Sphinx processing.
• Fix documentation of members that are arrays. Previously struct members that
  were array types would cause an error as the array size was put between the
  type and the member name.
• Fix viewcode processing of empty files. Previously an exception would be
  raised when the viewcode extension tried to process empty files.
• Call out Sphinx 3.1 as minimum version in setup.py. Previously the Sphinx
  version in setup.py called out 3.0 or greater. This was incorrect as features
  from Sphinx 3.1 are being utilized.

v0.3.1

Added

• The sphinx-c-apidoc command. This command provides users the ability to quickly build up a set of documentation files for a C directory.
• Support for compile flags via a compilation database. A compilation database can now be specified with the c_autodoc_compilation_database configuration value.

Fixes

• No longer passing typedef to auto documentation of types. Previously the typedef keyword was being provided to sphinx as part of the signature. This resulted in losing the ability to link to the type in html documentation.
• Display of function arguments with unknown array types. Previously when a function had an argument that was an array and an unknown type, it would result in being empty in the output documentation. Now the full function signature is provided token by token, with the exception of comments.