.. _api:

API Docs
========

This documentation is automatically generated from Flask-Breadcrumbs's source
code.

Flask extension
---------------
.. module:: flask.ext.breadcrumbs

.. autoclass:: Breadcrumbs
   :members:

Decorators
----------

.. autofunction:: register_breadcrumb

.. autofunction:: default_breadcrumb_root

Proxies
-------

.. data:: current_breadcrumbs

   List of breadcrumbs for current request.

.. data:: breadcrumbs_root_path

   Name of breadcrumbs root path.