Changelog

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.

1.2.0 - 2024-09-01

Compare with 1.1.0

Features

Provide hook interface, use it to expand identifiers, attach additional context to references, and give more context around unmapped identifiers (fb8df98 by Timothée Mazzucotelli). Issue-54, PR-mkdocstrings#666
Add option to resolve autorefs to closest URLs when multiple ones are found (2916eb2 by Timothée Mazzucotelli). Issue-52

Bug Fixes

Don't ignore identifiers containing spaces and slashes (b36a0d1 by Timothée Mazzucotelli). Issue-55

Code Refactoring

Emit deprecation warnings when old-style spans are found (4f2be46 by Timothée Mazzucotelli).
Use %s formatting instead of f-strings in log messages (0cedf9d by Timothée Mazzucotelli).

1.1.0 - 2024-08-20

Compare with 1.0.1

Deprecations

AUTO_REF_RE is renamed AUTOREF_RE (and updated for an improved version of fix_refs)
AutoRefInlineProcessor is renamed AutorefsInlineProcessor

Features

Warn when multiple URLs are found for the same identifier (c630354 by Markus B). Issue-35, PR-50, Co-authored-by: Timothée Mazzucotelli [email protected]

Bug Fixes

Only log "Markdown anchors feature enabled" once (1c9bda1 by Timothée Mazzucotelli). Issue-44

Code Refactoring

Use a custom autoref HTML tag (e142023 by Timothée Mazzucotelli). PR-48
Rename AutoRefInlineProcessor to AutorefsInlineProcessor (ffcaa01 by Timothée Mazzucotelli).
Attach name to processors for easier retrieval (036b825 by Timothée Mazzucotelli).

1.0.1 - 2024-02-29

Compare with 1.0.0

Bug Fixes

Don't import MkDocsConfig (does not exist on MkDocs 1.3-) (9c15664 by Timothée Mazzucotelli).

1.0.0 - 2024-02-27

Compare with 0.5.0

Features

Add Markdown anchors and aliases (a215a97 by Timothée Mazzucotelli). Replaces-PR-#20, Related-to-PR-#25, Related-to-issue-#35, Co-authored-by: Oleh Prypin [email protected], Co-authored-by: tvdboom [email protected]
Preserve HTML data attributes (from spans to anchors) (0c1781d by Timothée Mazzucotelli). Issue-#41, PR-#42, Co-authored-by: Oleh Prypin [email protected]
Support [`identifier`][] with pymdownx.inlinehilite enabled (e7f2228 by Oleh Prypin). Issue-#34, PR-#40, Co-authored-by: Timothée Mazzucotelli [email protected]

Bug Fixes

Recognize links with multi-line text (225a6f2 by Oleh Prypin). Issue #31, PR #32

0.5.0 - 2023-08-02

Compare with 0.4.1

Breaking Changes

Drop support for Python 3.7

Build

Migrate to pdm-backend (48b92fb by Michał Górny).

Bug Fixes

Stop using deprecated warning_filter (7721103 by Kyle King). PR #30

Code Refactoring

Use new MkDocs plugin logger if available (ca8d758 by Timothée Mazzucotelli).

0.4.1 - 2022-03-07

Compare with 0.4.0

Bug Fixes

Fix packaging (missing __init__ module) (de0670b by Timothée Mazzucotelli). Issue #17, issue mkdocstrings/mkdocstrings#398, PR #18

0.4.0 - 2022-03-07

Compare with 0.3.1

Features

Add HTML classes to references: autorefs always, and autorefs-internal or autorefs-external depending on the link (39db59d by Timothée Mazzucotelli). PR #16

Bug Fixes

Don't compute relative URLs of already relative ones (f6b861c by Timothée Mazzucotelli). PR #15

0.3.1 - 2021-12-27

Compare with 0.3.0

Code Refactoring

Support fallback method returning multiple identifiers (0d2b411 by Timothée Mazzucotelli). Issue #11, PR #12 and mkdocstrings#350

0.3.0 - 2021-07-24

Compare with 0.2.1

Features

Add optional-hover ref type (0288bdd by Brian Koropoff). PR #10

0.2.1 - 2021-05-07

Compare with 0.2.0

Bug Fixes

Prevent error during parallel installations (c90e399 by Timothée Mazzucotelli). PR #9

0.2.0 - 2021-05-03

Compare with 0.1.1

Features

Allow registering absolute URLs for autorefs (621686b by Oleh Prypin). PR #8
Allow external tools to insert references that are OK to skip (7619c28 by Oleh Prypin). PR #7
Allow [``identifier``][], understood as [``identifier``][identifier] (2d3182d by Oleh Prypin). PR #5

0.1.1 - 2021-02-28

Compare with 0.1.0

Packaging

Remove unused dependencies (9c6a8e6 by Oleh Prypin).

0.1.0 - 2021-02-17

Compare with first commit

Features

Split out "mkdocs-autorefs" plugin from "mkdocstrings" (fe6faa5 by Oleh Prypin).