# cross_ref URL: /api/health/validators/cross_ref/ Section: validators -------------------------------------------------------------------------------- cross_ref - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Health Validators ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module health.validators.cross_ref Cross-reference validator for validating semantic references in content. Validates that code references, configuration mentions, and other semantic links in documentation actually exist and are current. Key Features: Validate function/class references against source code Validate configuration option references Find broken anchor links to headings Detect stale version references Related Modules: bengal.health.base: BaseValidator interface bengal.health.report: CheckResult for reporting See Also: bengal/health/validators/links.py: URL link validation bengal/debug/base.py: Debug tool infrastructure View source 3 Classes 1 Function Classes CodeReference dataclass A reference to code in documentation content. 1 Caret Right A reference to code in documentation content. Attributes Name Type Description ref_type str Type of reference (function, class, config, variable) name str The referenced name module str | None Optional module path raw str Raw matched text line int Line number in content file_path str Path to the content file Internal Methods 1 Caret Right __str__ 0 str Caret Right def __str__(self) -> str Returns str CodeIndex dataclass Index of code symbols for validation. 2 Caret Right Index of code symbols for validation. Attributes Name Type Description functions set[str] Set of function names classes set[str] Set of class names constants set[str] Set of constant names config_options set[str] Set of configuration option names modules set[str] Set of module paths Methods 2 from_directory classmethod Build code index from a source directory. Parses Python files to extract funct… 1 CodeIndex Caret Right def from_directory(cls, source_dir: Path) -> CodeIndex Build code index from a source directory. Parses Python files to extract function, class, and constant names. Parameters 1 source_dir Path Directory containing Python source code Returns CodeIndex — CodeIndex with discovered symbols contains Check if a reference exists in the index. 1 bool Caret Right def contains(self, ref: CodeReference) -> bool Check if a reference exists in the index. Parameters 1 ref CodeReference Returns bool CrossReferenceValidator Validates semantic cross-references in documentation. Checks that code references (functions, clas… 7 Caret Right Validates semantic cross-references in documentation. Checks that code references (functions, classes, config options) in documentation actually exist in the source code. Creation: health_check.register(CrossReferenceValidator(source_dirs=[Path("src")])) Inherits from BaseValidator Attributes Name Type Description source_dirs — Directories to search for source code code_index — Index of discovered code symbols config_options — Known configuration option names current_version — Current product version for version checks deprecated_versions — List of deprecated version strings Methods 1 validate Validate cross-references in all site pages. 2 list[CheckResult] Caret Right def validate(self, site: Site, build_context: Any | None = None) -> list[CheckResult] Validate cross-references in all site pages. Parameters 2 site Site Site to validate build_context Any | None Optional BuildContext (not used by this validator) Returns list[CheckResult] — List of CheckResults for invalid references Internal Methods 6 Caret Right __init__ Initialize cross-reference validator. 4 None Caret Right def __init__(self, source_dirs: list[Path] | None = None, config_options: set[str] | None = None, current_version: str | None = None, deprecated_versions: list[str] | None = None) Initialize cross-reference validator. Parameters 4 source_dirs list[Path] | None Directories containing source code to index config_options set[str] | None Known configuration option names current_version str | None Current product version deprecated_versions list[str] | None List of deprecated versions to flag _validate_page Validate references in a single page. 1 list[CheckResult] Caret Right def _validate_page(self, page: Any) -> list[CheckResult] Validate references in a single page. Parameters 1 page Any Returns list[CheckResult] _extract_references Extract code references from content. Looks for: - `function_name()` - functio… 2 list[CodeReference] Caret Right def _extract_references(self, content: str, file_path: str) -> list[CodeReference] Extract code references from content. Looks for: function_name() - function calls in backticks ClassName - CamelCase names in backticks (classes) config_option - snake_case names in backticks (config) CONSTANT_NAME - UPPER_CASE names in backticks (constants) Parameters 2 content str Page content to search file_path str Path to the content file Returns list[CodeReference] — List of CodeReference objects _validate_reference Validate a single code reference. 1 CheckResult | None Caret Right def _validate_reference(self, ref: CodeReference) -> CheckResult | None Validate a single code reference. Parameters 1 ref CodeReference Reference to validate Returns CheckResult | None — CheckResult if invalid, None if valid _validate_versions Validate version references in content. 2 list[CheckResult] Caret Right def _validate_versions(self, content: str, file_path: str) -> list[CheckResult] Validate version references in content. Parameters 2 content str Page content file_path str Path to content file Returns list[CheckResult] — List of CheckResults for deprecated versions _validate_anchors Validate anchor links to headings. 1 list[CheckResult] Caret Right def _validate_anchors(self, page: Any) -> list[CheckResult] Validate anchor links to headings. Parameters 1 page Any Page to validate Returns list[CheckResult] — List of CheckResults for broken anchors Functions create_cross_ref_validator Factory function to create a configured CrossReferenceValidator. 3 CrossReferenceValidator Caret Right def create_cross_ref_validator(site_root: Path, source_dir: str = 'bengal', config_options: set[str] | None = None) -> CrossReferenceValidator Factory function to create a configured CrossReferenceValidator. Parameters 3 Name Type Default Description site_root Path — Root path of the site source_dir str 'bengal' Name of source code directory config_options set[str] | None None Optional set of known config option names Returns CrossReferenceValidator — Configured CrossReferenceValidator ← Previous connectivity Next → fonts List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1740 - Reading Time: 9 minutes