From bd73fc6cc17544d14b029c528cd70da73dd0a364 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Sun, 17 Jan 2010 17:55:39 +0000 Subject: Using a single chapter for the API docs and a single chapter for the ZCML directives made it hard to read. --- docs/authorintro.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'docs/authorintro.rst') diff --git a/docs/authorintro.rst b/docs/authorintro.rst index 4355fc125..c4b19338f 100644 --- a/docs/authorintro.rst +++ b/docs/authorintro.rst @@ -52,7 +52,7 @@ Book Content ============ This book is divided into three major parts: a narrative documentation -part, a tutorial part, and an API documentation part. +part, a tutorial part, and a reference part. Narrative Documentation @@ -66,14 +66,16 @@ Narrative Documentation Tutorials - Each tutorial builds a sample application or implements a concept - and describes the concept in terms of the example. You should read - the tutorials if you want a guided tour of :mod:`repoze.bfg`. + 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 - The API documentation is reference material related to the - :mod:`repoze.bfg` API. Use it while you're developing a + 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. .. index:: -- cgit v1.2.3