Skip to content

Commit 1aab7b5

Browse files
committed
Enable autorefs plugin option to resolve closest references
The new version of the plugin will warn if there are multiple references to the same object, for example: ``` WARNING - mkdocs_autorefs: Multiple secondary URLs found for 'frequenz.client.base.exception.ApiClientError.description': ['reference/frequenz/client/microgrid/#frequenz.client.microgrid.ApiClientError.description', 'reference/frequenz/client/microgrid/#frequenz.client.microgrid.ClientNotConnected.description']. ``` To avoid this we enable the `resolve_closest` option: https://mkdocstrings.github.io/autorefs/#non-unique-headings But this looks like a bug in the plugin, so we'll see: mkdocstrings/autorefs#52 (comment) Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 83d15a4 commit 1aab7b5

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ markdown_extensions:
8787
permalink: "¤"
8888

8989
plugins:
90+
- autorefs:
91+
resolve_closest: true
9092
- gen-files:
9193
scripts:
9294
- docs/_scripts/mkdocstrings_autoapi.py

0 commit comments

Comments
 (0)