This commit is contained in:
Jeff Balogh 2009-11-06 22:15:27 -08:00
Родитель b613dab334
Коммит 784b3b17bf
2 изменённых файлов: 69 добавлений и 0 удалений

68
docs/getting-started.rst Normal file
Просмотреть файл

@ -0,0 +1,68 @@
.. _getting-started:
===============
Getting Started
===============
You won't be going too far without :ref:`installation` unless you're just here
to read.
How these Docs are Arranged
---------------------------
Topics
~~~~~~
These are fairly broad narratives that cover things like Django or Sphinx, with
lots of links to more in-depth coverage.
.. toctree::
:maxdepth: 1
:glob:
topics/*
Reference
~~~~~~~~~
Reference pages are more like typical API docs, using docstrings and narratives
to cover internal packages.
.. toctree::
:maxdepth: 1
:glob:
ref/*
Things to learn about:
Django
* ORM
* CSRF
* Forms
* testing
* best practices, app layout
* multidb, master-slave
Jinja
* builtin filters
* :mod:`jingo`
Sphinx
* basic syntax
* referencing modules
Things that need work
* finding translation strings & context
* fetching translations
* where to put jinja extensions
* caching
* continuous integration
* nose testing
* production

Просмотреть файл

@ -27,6 +27,7 @@ Contents:
:maxdepth: 2
:glob:
getting-started
installation
ref/*