Skip to content

Releases: daizutabi/mkapi

Version 1.0.8

20 Jun 04:38
Compare
Choose a tag to compare
  • Added
    • short filter to remove the prefix from an object name (#16). Thanks to Ahrak.

Version 1.0.7

20 Jun 04:37
Compare
Choose a tag to compare
  • Changed
    • Top level object style.
    • Hide function prefix by display: none; in CSS.

Version 1.0.6

19 Jun 06:23
Compare
Choose a tag to compare
  • Changed
    • Object type style: Bold upper case -> italic lower case, as in the readthedocs.
    • Hide method prefix by display: none; in CSS.
  • Fixed
    • type: description style docstring is interpreted as a pair of return type and description only if the object is a property (#17).

Version 1.0.5

18 Jun 13:41
Compare
Choose a tag to compare
  • Changed

    • Use theme's Admonition for Note[s] and Warning[s] sections.
    • Update CSS (#8). Thanks to Ahrak.
  • Fixed

    • Attribute inspection from docstring.
    • Display base class in non-strict mode.
    • Catch NameError in resolving typing.ForwardRef (#14).
    • Delete unrelated members in a decorated function.
    • Inspect type of decorated functions correctly.
    • Skip multiple assignments per line during attribute inspection (#15).

Version 1.0.4

17 Jun 02:06
Compare
Choose a tag to compare
  • BugFix: Include decorated functions if decorator uses functools.wraps().
  • all filter for package or module to display all of the members and add links to them.
  • Add link from table of contents to source.

Version 1.0.3

16 Jun 16:12
Compare
Choose a tag to compare
  • BugFix: Include functions decorated by Pytest (#14).
  • Add link from property documentation to source code vice versa.
  • reStructuredText type link like Object_.
  • Support of string type annotation like ForwardRef.

Version 1.0.2

16 Jun 09:33
Compare
Choose a tag to compare
  • BugFix: Correct parameter names for *args and **kwargs.
  • Add title attribute to [DOCS] and [SOURCE] link to display the object id.

Version 1.0.0

16 Jun 09:29
Compare
Choose a tag to compare
  • Add support for NumPy docstring style (#1).
  • Document only a specific method from a class (#5).
  • Add support for magic/dunder methods (#7).
  • Include methods defined in different file (#9).
  • Display inheritance of class (#10).
  • Add on_config option to allow users to run custom script (#11).