pub fn is_mkdocs_auto_reference(reference: &str) -> boolExpand description
MkDocs pattern detection utilities
Provides centralized pattern detection for MkDocs auto-references.
§MkDocs Auto-References
This module detects patterns used by MkDocs ecosystem plugins, particularly:
- mkdocs-autorefs: Automatic cross-references in documentation
- mkdocstrings: Python API documentation generation
§Supported Patterns
§Module/Class References
- Format:
module.Class,package.module.function - Example:
[module.MyClass][],[api.endpoints.get_user][] - Used for: Python API documentation cross-references
§Header Anchors
- Format:
getting-started,api-reference - Example:
[getting-started][],[installation-guide][] - Used for: Cross-references to documentation sections
§API Paths
- Format:
api/v1/endpoints,docs/reference/guide - Example:
[api/module.Class][],[docs/getting-started][] - Used for: Navigation and documentation structure references
§References
- https://mkdocstrings.github.io/autorefs/
- https://mkdocstrings.github.io/
- https://github.com/mkdocs/mkdocs/discussions/3754
§See Also
MD042NoEmptyLinks- Handles MkDocs auto-referencesis_mkdocs_attribute_anchormethod - Handles attr_list anchors