.. _index:

==========================
 repoze.bfg Documentation
==========================

``repoze.bfg`` is a web application framework based on graph
traversal.  It is inspired by Zope's publisher, though less ambitious
in scope.  Instead, it embraces WSGI and existing WSGI software.

Narrative documentation
-----------------------

Narrative documentation in chapter form explaining how to use
:mod:`repoze.bfg`.

.. toctree::
   :maxdepth: 2

   narr/introduction
   narr/install
   narr/project
   narr/traversal
   narr/views
   narr/templates
   narr/models
   narr/security
   glossary

Tutorials
----------

Step-by-step sample applications that use ``repoze.bfg``.

.. toctree::
   :maxdepth: 3

   tutorials/lxmlgraph/index.rst

API documentation
-----------------

.. toctree::
   :maxdepth: 2

   api/push
   api/router
   api/security
   api/template
   api/traversal
   api/urldispatch
   api/wsgi

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`