All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v0.3.0 - 2020-04-10
- Support different indentations and complex markup in docstrings sections (2f53082 by Timothée Mazzucotelli). Related issues/PRs: #17
v0.2.1 - 2020-04-07
- Fix forward refs replacement for python > 3.6 (6a90aca by Timothée Mazzucotelli).
- Handle exception parsing error (d6561f8 by Timothée Mazzucotelli). Related issues/PRs: #16
v0.2.0 - 2020-03-27
- Add members and filters options (7af68cc).
- Read type annotations in docstrings.
- Add modules' source code to the output (f05290b).
- The code was refactored for readability and robustness (ef9ba9d).
This is a breaking change as some items in the JSON output have changed:
- the object
signature
value was moved fromobj.docstring.signature
toobj.signature
, - the docstring
sections
value was moved fromobj.docstring.sections
toobj.docstring_sections
, - the docstring
parsing_errors
value was moved fromobj.docstring.parsing_errors
toobj.docstring_errors
,
- the object
v0.1.2 - 2020-03-23
- Catch error when trying to get builtins module file path (48df6bc).
v0.1.1 - 2020-03-21
- Fix 'no parsing_errors attribute in Docstring' error (0c8a986).
- Handle
KeyError
when searching for param type annotation in signature (b87fe78).
v0.1.0 - 2020-03-20
- Initial contents, moved from
mkdocstrings
and tweaked a bit.