Skip to content

Latest commit

 

History

History
126 lines (109 loc) · 4.92 KB

release_notes.rst

File metadata and controls

126 lines (109 loc) · 4.92 KB
Raw

Release notes

These release notes are based on Keep a Changelog. sphinx-codeautolink adheres to Semantic Versioning.

Unreleased

  • Support Python 3.10 (33)
  • Include the expected location of a type in codeautolink_warn_on_failed_resolve for debugging (106)
  • Define extension environment version for Sphinx (107)
  • Merge environments only when the extension is active (107)
  • Link arguments and annotated assignment with type hints (108)

0.10.0 (2022-01-25)

  • Don't try to link empty name between two subsequent calls (96)
  • Introduce codeautolink_warn_on_missing_inventory and codeautolink_warn_on_failed_resolve to issue additional warnings when linking or resolving an object fails (97)
  • Support callable classes (98)

0.9.0 (2022-01-13)

  • Use Sphinx logging instead of raising exceptions (86)
  • Link builtins if visible to intersphinx (87)
  • Use Sphinx logging instead of the builtin warnings to warn (89, 94)
  • Support IPython's .. ipython:: directive (91)

0.8.0 (2021-12-16)

  • Correctly test for optional types in annotations (72)
  • Don't check for notranslate CSS class, allowing for additional classes (75)
  • Allow to specify block parsers as importable references (76)
  • Allow parallel builds (77)
  • Automatic support for ipython3 code blocks (79)
  • Correctly produce links for py code blocks (81)

0.7.0 (2021-11-28)

  • Declare CSS class as public API (3)
  • Add ability to link to subclass documentation (68)
  • Append a newline to error messages with source code (70)
  • Fix unpacking starred assignment (71)
  • Improve errors with information about the current document (71)

0.6.0 (2021-11-21)

  • Remove text decoration from produced links (3)
  • Turn autodoc integration off by default (58)
  • Avoid index error when handling syntax errors (60)
  • Construct fully-qualified names more strictly to avoid hiding other issues (61)
  • Resolve string annotations in the module scope (62)
  • Correctly ensure that return annotations are valid types (63)
  • Resolve imported functions to their original location if a documentation entry is not found in the used location (64)
  • Fix multi-target assignment and unpacked assignment (66)
  • Correctly accept None as a custom block transformer (67)
  • Document support for sphinx.ext.doctest blocks (67)

0.5.1 (2021-11-20)

  • Fix intersphinx links in documents inside folders (56)

0.5.0 (2021-11-07)

This release changes an internal API. Please delete the cache file before building documentation.

  • Link import statements (42)
  • Gracefully handle functions that don't have an annotations dict (47)
  • Enable configurations without autodoc (48)
  • Support custom code block syntax (49)
  • Fix crash on annotation-only assignment (50)
  • Fix issue with filenames that have dots (52)
  • Correctly remove extension when building non-HTML documentation (53)
  • Support searching extra CSS classes for code example matching (54)
  • Add configuration for global default concatenation state (55)

0.4.0 (2021-10-08)

  • Support fluent interfaces (37)
  • Fix links for names that shadow builtins (38)
  • Support doctest blocks (39)

0.3.0 (2021-10-05)

  • Treat optional types as their underlying type (21)
  • Improve autolink-examples argument structure and provide an option making a collapsible table (25)
  • Rename directives for consistency (27)
  • Correctly link decorators (28)
  • Move cache to Sphinx doctree directory (29)
  • Support Python console blocks (30)
  • Add configuration for default import statements (31)
  • Support star imports (32)
  • Accept multiline prefaces (35)
  • Fix autodoc injection on one-line docstrings (36)

0.2.1 (2021-10-01)

  • Fix type resolving for class instances (24)

0.2.0 (2021-10-01)

  • Improve code analysis and follow simple type hints (5)
  • Improve directive arguments and behavior (16)
  • Correctly consume autolink-skip:: next (17)
  • Find type hints via imports, fix links in partial builds (18)

0.1.1 (2021-09-22)

  • Correctly filter out names from concatenated sources (14)
  • Fix links in documents inside folder (15)

0.1.0 (2021-09-22)

Initial release