firecrown.fctools.generate_symbol_map
=====================================

.. py:module:: firecrown.fctools.generate_symbol_map

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

   firecrown.fctools.generate_symbol_map.repo_root
   firecrown.fctools.generate_symbol_map.app


Functions
---------

.. autoapisummary::

   firecrown.fctools.generate_symbol_map.get_all_symbols
   firecrown.fctools.generate_symbol_map.main


Module Contents
---------------

.. py:data:: repo_root

.. py:function:: get_all_symbols(package)

   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.

   :param package: The Python package to inspect
   :return: Dictionary mapping symbol names to their documentation URLs


.. py:data:: app

.. py:function:: 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).'))

   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.