Skip to content

Commit

Permalink
Add new autorefs plugin option to resolve_closest
Browse files Browse the repository at this point in the history
When multiple URLs were found for a autoref, the plugin emits a warning,
which in our setup breaks the build as we use strict mode. This new
option allows to resolve the reference to the "closest URL".

See the documentation for more information:
https://github.com/mkdocstrings/autorefs#non-unique-headings

Signed-off-by: Leandro Lucarella <luca-frequenz@llucax.com>
  • Loading branch information
llucax committed Sep 2, 2024
1 parent d6dad00 commit 729c697
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ markdown_extensions:
permalink: "¤"

plugins:
- autorefs:
resolve_closest: true
- gen-files:
scripts:
- docs/_scripts/mkdocstrings_autoapi.py
Expand Down

0 comments on commit 729c697

Please sign in to comment.