Added the basics needed to build Django's docs using [http://sphinx.pocoo.org/ Sphinx]. If you've got Sphinx installed (the latest version) along with [http://docutils.sf.net docutils], you should be able to easily build the docs locally using {{{sphinx-build}}} or the included {{{Makefile}}}. This use a basic (and pretty crappy) index for the documentation and the built-in Sphinx styles (which are actually quite nice).

git-svn-id: http://code.djangoproject.com/svn/django/trunk@7370 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
Jacob Kaplan-Moss 2008-03-27 15:03:52 +00:00
parent d5cb46f412
commit 7dd4be581b
3 changed files with 328 additions and 0 deletions

128
docs/index.txt Normal file
View file

@ -0,0 +1,128 @@
====================
Django Documentation
====================
The essential documentation
===========================
If you're new to Django, make sure to read the following documentation in
order.. The rest (in the "reference" section below) can be ready in any order as
you need various functionality.
.. toctree::
:maxdepth: 1
overview
install
tutorial01
tutorial02
tutorial03
tutorial04
faq
documentation
Reference
=========
.. toctree::
:maxdepth: 1
django-admin
model-api
db-api
transactions
templates
templates_python
newforms
modelforms
testing
sessions
cache
settings
url_dispatch
request_response
generic_views
authentication
shortcuts
unicode
pagination
serialization
i18n
middleware
custom_model_fields
databases
``django.contrib`` add-ons
--------------------------
.. toctree::
:maxdepth: 1
add_ons
contenttypes
csrf
databrowse
flatpages
form_preview
form_wizard
localflavor
redirects
sites
sitemaps
syndication_feeds
webdesign
Deployment
----------
.. toctree::
:maxdepth: 1
modpython
fastcgi
Solving specific problems
-------------------------
.. toctree::
:maxdepth: 1
apache_auth
static_files
email
legacy_databases
outputting_pdf
outputting_csv
Et cetera
---------
.. toctree::
:maxdepth: 1
design_philosophies
contributing
admin_css
api_stability
Release notes
-------------
.. toctree::
:maxdepth: 1
release_notes_0.96
release_notes_0.95
Also see the list of `backwards-incompatible changes`__ for changes made between
releases.
__ http://code.djangoproject.com/wiki/BackwardsIncompatibleChanges
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`