CHANGELOG.md

Changelog

3.2.2 (2024-09-06)

Bug Fixes

• Ignore disambiguation for repeated entries (#390) (917c89b)
• Retrieve keyword arguments for docstrings (#389) (bb6898e)

3.2.1 (2024-05-07)

Bug Fixes

• Build Markdown relative to input directory (#380) (2a4b9fe)
• Format enum data into table format (#376) (abc9667)

3.2.0 (2024-05-02)

Features

• Add support for enums (#374) (4575ffe)

Documentation

• Add summary_overview template (#367) (39baecb)

3.1.0 (2024-04-01)

Features

• Add summary page for Classes and Modules (#361) (e56c3a7)
• Add summary page support for methods and properties (#363) (e3ae026)
• Grab repository metadata (#364) (1318b24)
• Support overview page (#365) (9985d13)

3.0.1 (2024-03-13)

Bug Fixes

• Update dependencies to pin Sphinx for <5 compatibility (#342) (e60753a)

3.0.0 (2023-11-02)

⚠ BREAKING CHANGES

• Bump minimum version to 3.10 (#334)

Features

• Bump minimum version to 3.10 (#334) (97c34cb)

2.0.7 (2023-11-01)

Bug Fixes

• Ignore cross reference conversion in examples (#332) (bbfa011)

2.0.6 (2023-10-30)

Bug Fixes

• Refactor type hint retrieval (#312) (0c91f60)
• Support docstrings without type added (#311) (d214d64)
• Update annotation name extraction logic and add unit tests (#320) (220951d)

2.0.5 (2023-06-27)

Bug Fixes

• Pin markdown builder version (#306) (0d1879d)

2.0.4 (2023-06-02)

Bug Fixes

• Allow top level page to only have index page (#301) (85c049a)

2.0.3 (2023-03-22)

Bug Fixes

• Add support for return annotation in syntax (#291) (16894ce)

2.0.2 (2023-02-03)

Bug Fixes

• Allow multiple/custom index pages to be used (#280) (7ee38d8)

2.0.1 (2023-01-30)

Bug Fixes

• Remove license headers in markdown files (#273) (a4c808f)

2.0.0 (2022-11-15)

⚠ BREAKING CHANGES

• Retrieve all markdown pages (#266)

Features

• Add golden testing (#262) (ff8902e)
• Retrieve all markdown pages (#266) (1cee1ed)

Bug Fixes

• Remove inheritance details (#268) (43751cf)
• Remove unused YAML fields to fix presubmit (#265) (10ecc44)

1.6.0 (2022-10-13)

Features

• Use GitHub's default README as index page (#255) (17f6ca0)

Bug Fixes

• Render emphasis properly and markdown in tables (#258) (4bbd921)

1.5.0 (2022-07-11)

Features

• support devsite notices (#222) (0da9224)

Bug Fixes

• include dependency for librarytest (#218) (420780b)

1.4.8 (2022-05-24)

Bug Fixes

• add hardcoded IAM references temporarily (#209) (5dc99d2)

1.4.7 (2022-04-12)

Bug Fixes

• add markdown header if it is missing (#203) (ccd53bd)

1.4.6 (2022-04-06)

Bug Fixes

• support parsing summary docstring that is not well formed (#200) (a1b362d)

1.4.5 (2022-03-18)

Bug Fixes

• format code snippets properly (#193) (ef7a337)

1.4.4 (2022-03-03)

Bug Fixes

• parse docstring that come without summaries (#187) (8282604)

1.4.3 (2022-02-15)

Bug Fixes

• retrieve constructors (#181) (1e6efa4)
• use id field for Attributes instead of name (#179) (fa38c8c)

1.4.2 (2022-02-07)

Bug Fixes

• update markdown header parser (#177) (71d50cc)

1.4.1 (2022-01-28)

Bug Fixes

• enable upgrading docs (#172) (bb68ea9)

1.4.0 (2022-01-28)

Features

• add syntax highlighting support for Markdown pages (#170) (9898807)

1.3.3 (2021-11-29)

Bug Fixes

• expand entry names in Overview page to be more descriptive (#159) (7bd6416)

1.3.2 (2021-11-16)

Bug Fixes

• gracefully handle format_code exceptions (#152) (a679ace)

1.3.1 (2021-11-15)

Bug Fixes

• resolve square bracketed references (#146) (fa049ac)

1.3.0 (2021-11-15)

Features

• format signature using black (#144) (4462b93)

1.2.0 (2021-10-05)

Features

• find more items to cross reference (#138) (a0f82dd)

1.1.2 (2021-09-14)

Bug Fixes

• disambiguate after grouping by packages and versions (#132) (53d68fe)

1.1.1 (2021-08-30)

Bug Fixes

• make plugin more verbose (#123) (1f25757)

1.1.0 (2021-08-26)

Features

• handle additional docstring items (#116) (8c31924)

1.0.1 (2021-08-25)

Bug Fixes

• do not omit arguments retrieved from docstring (#114) (18bf0de)
• parse markdown header more carefully (#111) (485b248)

1.0.0 (2021-08-24)

⚠ BREAKING CHANGES

• add markdown page support (#102)

Features

• add markdown page support (#102) (878f1c3)
• group left-nav entries into versions and groups (#96) (ee89394)

Bug Fixes

• recover lost function arguments and argument types (#93) (b90dd0f)
• retrieve file name as much as possible (#100) (34cad2b)
• use file name instead of object name for TOC (#97) (48279ef)
• use the uid for toc entries (#104) (1364dfc)

0.5.2 (2021-07-30)

Bug Fixes

• parse xrefs differently with new xref format (#90) (22485e8)

0.5.1 (2021-07-29)

Bug Fixes

• handle more xrefs and keep long uid (#85) (fd4f9f3)
• remove redundant class info for subclasses (#87) (06bb556)

0.5.0 (2021-07-28)

Features

• add subclasses to children and reference (#77) (0cab5f6)
• add subPackage types for better classification (#76) (3c84f3e)
• process xrefs properly (#78) (fcc1989)

0.4.0 (2021-07-21)

Features

• add short snippet for missing summary (#73) (bb432e7)

Bug Fixes

• disambiguate all entry names to clarify duplicate names (#72) (b632eb7)

0.3.4 (2021-07-05)

Bug Fixes

• deduplicate entries in children and references (#61) (6d5407b)

0.3.3 (2021-06-25)

Bug Fixes

• handle entries that cannot be disambiguated (#59) (7678b24)

0.3.2 (2021-06-24)

Bug Fixes

• properly handle Raises section for GoogleDocstring (#56) (793dd48)
• update parser to correctly parse desired tokens (#55) (d1e18c7)

0.3.1 (2021-06-21)

Bug Fixes

• update dependency requirements (#48) (c1c036f)

0.3.0 (2021-06-21)

Features

• Add support for Property and missing content (#41) (5ac499f)
• shorten function names shown on pages (#22) (13edc85)

Bug Fixes

• complete toc disambiguation (#45) (8928614)
• remove function and method name override (#42) (ab8f265)

0.2.0 (2021-05-13)

Features

• clarify names in the left nav (#16) (14cac76)

0.1.0 (2021-03-25)

Documentation

• keep Python COC, update README (#6) (3a60b1a)