From 9e3bdbce1063f67b2e927fec0677cf74095ea9ad Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Wed, 16 Jul 2008 22:25:43 +0000 Subject: Rearrange into narrative and API sections; include README in narrative as "introduction". --- docs/index.rst | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 99589e1d9..bc6dbb303 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,34 @@ repoze.bfg Documentation ======================== -Contents: +Narrative documentation +----------------------- + +Narrative documentation in chapter form explaining how to use +:mod:`repoze.bfg`. + +.. toctree:: + :maxdepth: 2 + + narr/introduction + +API documentation +----------------- + +:mod:`repoze.bfg` +----------------- + +The :mod:`repoze.bfg` package contains the code nececessary to create +and run a web application. .. toctree:: - :maxdepth: 3 + :maxdepth: 2 - modules/index + api/push + api/router + api/security + api/template + api/view Indices and tables ================== -- cgit v1.2.3