From 7a39859ae4242f3d80f46173f2efa51ff2664869 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sat, 26 Dec 2009 20:01:45 +0000 Subject: Provide a dedicated latex index. --- docs/conf.py | 4 +- docs/latexindex.rst | 163 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 165 insertions(+), 2 deletions(-) create mode 100644 docs/latexindex.rst diff --git a/docs/conf.py b/docs/conf.py index a67a6206f..905d7c197 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -166,7 +166,7 @@ latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'repozebfg.tex', 'repoze.bfg Documentation', 'Chris McDonough', + ('latexindex', 'repozebfg.tex', 'repoze.bfg Documentation', 'Chris McDonough', 'manual'), ] @@ -185,4 +185,4 @@ latex_use_parts = True #latex_appendices = [] # If false, no module index is generated. -latex_use_modindex = True +latex_use_modindex = False diff --git a/docs/latexindex.rst b/docs/latexindex.rst new file mode 100644 index 000000000..4128e4072 --- /dev/null +++ b/docs/latexindex.rst @@ -0,0 +1,163 @@ +.. _index: + +@@@@@@@@@@ +repoze.bfg +@@@@@@@@@@ + +:mod:`repoze.bfg` is a Python web application framework. It is +inspired by :term:`Zope`, :term:`Pylons`, and :term:`Django`. It uses +various Zope-related libraries internally to do much of its work. +:mod:`repoze.bfg` uses the WSGI protocol to handle request and +responses. + +:mod:`repoze.bfg` is developed as part of the `Repoze +`_ project by `Agendaless Consulting +`_ and other contributors. It is licensed +under a `BSD-like license `_. + +Narrative Documentation +@@@@@@@@@@@@@@@@@@@@@@@ + +.. toctree:: + :maxdepth: 2 + + narr/introduction + narr/install + narr/configuration + narr/scanning + narr/project + narr/startup + narr/urlmapping + narr/traversal + narr/urldispatch + narr/views + narr/webob + narr/templates + narr/models + narr/security + narr/hybrid + narr/vhosting + narr/events + narr/environment + narr/unittesting + narr/hooks + narr/extending + narr/resources + narr/router + narr/threadlocals + +Tutorials +@@@@@@@@@ + +ZODB + traversal Wiki Tutorial +============================== + +Demonstrates how to build a :term:`traversal` based application using +:term:`ZODB` and :term:`authentication`. Good for people with prior +Zope experience (or no experience at all). + +.. toctree:: + :maxdepth: 2 + + tutorials/bfgwiki/index.rst + +SQLAlchemy + Url Dispatch Wiki Tutorial +======================================= + +Demonstrates how to build a :term:`url dispatch` based application +using :term:`SQLAlchemy` and :term:`authentication`. Good for people +with prior Pylons experience (or no experience at all). + +.. toctree:: + :maxdepth: 2 + + tutorials/bfgwiki2/index.rst + +:mod:`repoze.bfg` for Zope CMF Developers +========================================= + +.. toctree:: + :maxdepth: 2 + + tutorials/cmf/index.rst + +:mod:`repoze.bfg` on Google's App Engine +======================================== + +.. toctree:: + :maxdepth: 2 + + tutorials/gae/index.rst + +:mod:`repoze.bfg` under :term:`mod_wsgi` +======================================== + +.. toctree:: + :maxdepth: 2 + + tutorials/modwsgi/index.rst + +Using ZODB's :term:`ZEO` with :mod:`repoze.bfg` +=============================================== + +.. toctree:: + :maxdepth: 2 + + tutorials/zeo/index.rst + +Using ZODB Sessions in :mod:`repoze.bfg` +======================================== + +.. toctree:: + :maxdepth: 2 + + tutorials/zodbsessions/index.rst + +API documentation +@@@@@@@@@@@@@@@@@ + +.. toctree:: + :maxdepth: 2 + + api/authorization + api/authentication + api/chameleon_text + api/chameleon_zpt + api/configuration + api/events + api/exceptions + api/interfaces + api/location + api/paster + api/router + api/scripting + api/security + api/settings + api/testing + api/threadlocal + api/traversal + api/url + api/view + api/wsgi + +ZCML Directives +@@@@@@@@@@@@@@@ + +.. toctree:: + :maxdepth: 2 + + zcml + +Glossary +@@@@@@@@ + +.. toctree:: + :maxdepth: 1 + + glossary + +Index +@@@@@ + +* :ref:`genindex` + -- cgit v1.2.3