From 38b33d485322759050510c96a75334e36ca63c30 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 17 Jan 2010 18:19:58 +0000 Subject: Final layout. --- docs/api.rst | 24 ++++++++++++++++++++++++ docs/authorintro.rst | 24 +++++++++++++++--------- docs/latexindex.rst | 15 +++++++++++---- docs/zcml.rst | 27 +++++++++++++++++++++++++++ 4 files changed, 77 insertions(+), 13 deletions(-) create mode 100644 docs/zcml.rst diff --git a/docs/api.rst b/docs/api.rst index 70ec4c4f5..2bd5fca01 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -5,3 +5,27 @@ Comprehensive reference material for every public API exposed by :mod:`repoze.bfg` is available within this chapter. The API documentation is organized alphabetically by module name. +.. toctree:: + :maxdepth: 1 + + 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 + diff --git a/docs/authorintro.rst b/docs/authorintro.rst index c4b19338f..e1219a8e1 100644 --- a/docs/authorintro.rst +++ b/docs/authorintro.rst @@ -51,10 +51,11 @@ technologies. Book Content ============ -This book is divided into three major parts: a narrative documentation -part, a tutorial part, and a reference part. +This book is divided into four major parts: a narrative documentation +part, a tutorial part, an API reference part, and a ZCML directive +reference part. -Narrative Documentation +:ref:`narrative_documentation` This is documentation which describes :mod:`repoze.bfg` concepts in narrative form, written in a largely conversational tone. Each @@ -64,19 +65,24 @@ Narrative Documentation out-of-order, or when you need only a reminder about a particular topic while you're developing an application. -Tutorials +:ref:`tutorials` Each tutorial builds a sample application or implements a set of concepts with a sample; it then describes the application or concepts in terms of the sample. You should read the tutorials if you want a guided tour of :mod:`repoze.bfg`. -Reference +:ref:`api_reference` - Two parts form the reference section: the API documentation and - :term:`ZCML` directive documentation. These parts provide - convenient reference material related to developing a - :mod:`repoze.bfg` application. + Comprehensive reference material for every public API exposed by + :mod:`repoze.bfg`. The API documentation is organized + alphabetically by module name. + +:ref:`zcml_reference` + + Comprehensive reference material for every :term:`ZCML directive` + provided by :mod:`repoze.bfg`. The ZCML directive documentation is + organized alphabetically by directive name. .. index:: single: repoze.zope2 diff --git a/docs/latexindex.rst b/docs/latexindex.rst index d1105faa8..e40e57734 100644 --- a/docs/latexindex.rst +++ b/docs/latexindex.rst @@ -19,6 +19,8 @@ Front Matter .. mainmatter:: +.. _narrative_documentation: + Narrative Documentation @@@@@@@@@@@@@@@@@@@@@@@ @@ -48,6 +50,8 @@ Narrative Documentation narr/startup narr/threadlocals +.. _tutorials: + Tutorials @@@@@@@@@ @@ -62,8 +66,10 @@ Tutorials tutorials/zodbsessions/index.rst tutorials/catalog/index.rst -API Documentation -@@@@@@@@@@@@@@@@@ +.. _api_reference: + +API Reference +@@@@@@@@@@@@@ .. toctree:: :maxdepth: 1 @@ -89,9 +95,10 @@ API Documentation api/view api/wsgi +.. _zcml_reference: -ZCML Directives -@@@@@@@@@@@@@@@@ +ZCML Directive Reference +@@@@@@@@@@@@@@@@@@@@@@@@ .. toctree:: :maxdepth: 1 diff --git a/docs/zcml.rst b/docs/zcml.rst new file mode 100644 index 000000000..ba40f5072 --- /dev/null +++ b/docs/zcml.rst @@ -0,0 +1,27 @@ +ZCML Directives +=============== + +Comprehensive reference material for every ZCML directive provided by +:mod:`repoze.bfg` is available within this chapter. The ZCML +directive documentation is organized alphabetically by directive name. + +.. toctree:: + :maxdepth: 1 + + zcml/aclauthorizationpolicy + zcml/adapter + zcml/authtktauthenticationpolicy + zcml/configure + zcml/forbidden + zcml/include + zcml/notfound + zcml/remoteuserauthenticationpolicy + zcml/renderer + zcml/repozewho1authenticatiohnpolicy + zcml/resource + zcml/route + zcml/scan + zcml/static + zcml/subscriber + zcml/utility + zcml/view -- cgit v1.2.3