Skip to content

Commit 7145c15

Browse files
committed
docs
1 parent f201c88 commit 7145c15

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/usage/configuration/general.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -501,9 +501,9 @@ def some_function():
501501
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
502502
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
503503

504-
Whether to not give objects local inventory entries.
504+
Whether to skip registering symbols in the objects inventory.
505505

506-
With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
506+
With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local. Similarly, it becomes possible to render the same symbol several times in the same documentation, with only one canonical location being used for cross-references (preventing confusion in mkdocs-autorefs).
507507

508508
```yaml title="in mkdocs.yml (global configuration)"
509509
plugins:

0 commit comments

Comments
 (0)