83 lines (48 loc) · 1.86 KB

mkdocstring-python-xref changes

Note that versions roughly correspond to the version of mkdocstrings-python that they are compatible with.

2.1.1

Do not recurse into external imports when translating cross-references (#62)
Ignore some [..][..] doc-string references that cannot be cross-references (e.g. use for array-indexing syntax or optional arguments). (#63)

2.1.0

Added compatibility_check option to warn or error on cross-reference syntax that is not supported by the standard mkdocstrings-python handler (#60)
Added compatibility_patch option to generate a patch file converting incompatible cross-references to standard form (#60)

2.0.1

Fix extended template configuration (#56)

2.0.0

Depends on mkdocstrings-python >=2.0 and mkdocstrings >=1.0

1.16.5

Drop python 3.9 support

1.16.4

Fix handling of aliases (see bug #47)

1.16.3

Added check_crossrefs_exclude config option
Fix for issue 43

Thanks to @thetianshuhuang!

1.16.2

Improved source locations for errors in docstrings now including column numbers (starting at 1).

1.16.1

Fix sdist distributions (should enable conda-forge to build)

1.16.0

Compatibility with mkdocstrings-python 1.16.*
Removed some deprecated imports from mkdocstrings

1.14.1

Restrict to mkdocstrings-python <1.16 (see bug #32)

1.14.0

Work with mkdocstrings-python 1.14 or later
Drop python 3.8 support
Fix extra files in wheel's RECORD

1.6.2

Use griffe 1.0 or later

1.6.1

Available on conda-forge

1.6.0

Added explicit option to disable cross-reference checking.
When enabled, check all cross-references, not just relative ones
If reference begins with '?', don't check cross-reference.

1.5.3

First public release