diff options
| author | Chris McDonough <chrism@agendaless.com> | 2008-07-16 22:25:43 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2008-07-16 22:25:43 +0000 |
| commit | 9e3bdbce1063f67b2e927fec0677cf74095ea9ad (patch) | |
| tree | e55745c6710cd50c24450f6384dd6ba3b259e745 /docs/index.rst | |
| parent | 8b169d338e1ea6d07bc3cd0c9ff0b0ae91c56708 (diff) | |
| download | pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.tar.gz pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.tar.bz2 pyramid-9e3bdbce1063f67b2e927fec0677cf74095ea9ad.zip | |
Rearrange into narrative and API sections; include README in narrative as "introduction".
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 28 |
1 files changed, 25 insertions, 3 deletions
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 ================== |