firecrown.fctools.generate_symbol_map

Generate a JSON map of Firecrown symbols to their documentation URLs.

Attributes

`repo_root`
`app`

Functions

`get_all_symbols`(package)	Walk through a package and collect modules, classes, functions, and constants.
`main`([output, pretty])	Generate a JSON map of Firecrown symbols to their documentation URLs.

Module Contents

firecrown.fctools.generate_symbol_map.repo_root

firecrown.fctools.generate_symbol_map.get_all_symbols(package)[source]

Walk through a package and collect modules, classes, functions, and constants.

This function captures: - Classes and functions (with proper handling of re-exports) - Module-level constants (following naming conventions) - Singleton instances of Firecrown classes

This ensures that users can reference symbols using the documented public API paths rather than needing to know about private implementation modules.

Parameters:: package (types.ModuleType) – The Python package to inspect
Returns:: Dictionary mapping symbol names to their documentation URLs
Return type:: dict[str, str]

firecrown.fctools.generate_symbol_map.app

firecrown.fctools.generate_symbol_map.main(output=typer.Option(None, '--output', '-o', help='Output file path. If not specified, prints to stdout.', file_okay=True, dir_okay=False), pretty=typer.Option(True, '--pretty/--compact', help='Pretty-print JSON with indentation (default: pretty).'))[source]

Generate a JSON map of Firecrown symbols to their documentation URLs.

Introspects the Firecrown package to find all classes, functions, and module-level constants, then generates a mapping from symbol names to their Sphinx documentation URLs.

By default, outputs to stdout for easy piping. Use –output to write to a file.

Parameters:

output (pathlib.Path)
pretty (bool)

Return type:

None