Skip to content

v0.4.0

Choose a tag to compare

@speedyleion speedyleion released this 27 Dec 18:38

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.