summaryrefslogtreecommitdiff
path: root/parts/django/docs/index.txt
diff options
context:
space:
mode:
Diffstat (limited to 'parts/django/docs/index.txt')
-rw-r--r--parts/django/docs/index.txt213
1 files changed, 213 insertions, 0 deletions
diff --git a/parts/django/docs/index.txt b/parts/django/docs/index.txt
new file mode 100644
index 0000000..f163fd9
--- /dev/null
+++ b/parts/django/docs/index.txt
@@ -0,0 +1,213 @@
+
+.. _index:
+
+====================
+Django documentation
+====================
+
+.. rubric:: Everything you need to know about Django (and then some).
+
+Getting help
+============
+
+Having trouble? We'd like to help!
+
+* Try the :doc:`FAQ <faq/index>` -- it's got answers to many common questions.
+
+* Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
+ the :doc:`detailed table of contents <contents>`.
+
+* Search for information in the `archives of the django-users mailing list`_, or
+ `post a question`_.
+
+* Ask a question in the `#django IRC channel`_, or search the `IRC logs`_ to see
+ if it's been asked before.
+
+* Report bugs with Django in our `ticket tracker`_.
+
+.. _archives of the django-users mailing list: http://groups.google.com/group/django-users/
+.. _post a question: http://groups.google.com/group/django-users/
+.. _#django IRC channel: irc://irc.freenode.net/django
+.. _IRC logs: http://botland.oebfare.com/logger/django/
+.. _ticket tracker: http://code.djangoproject.com/
+
+First steps
+===========
+
+ * **From scratch:**
+ :doc:`Overview <intro/overview>` |
+ :doc:`Installation <intro/install>`
+
+ * **Tutorial:**
+ :doc:`Part 1 <intro/tutorial01>` |
+ :doc:`Part 2 <intro/tutorial02>` |
+ :doc:`Part 3 <intro/tutorial03>` |
+ :doc:`Part 4 <intro/tutorial04>`
+
+The model layer
+===============
+
+ * **Models:**
+ :doc:`Model syntax <topics/db/models>` |
+ :doc:`Field types <ref/models/fields>` |
+ :doc:`Meta options <ref/models/options>`
+
+ * **QuerySets:**
+ :doc:`Executing queries <topics/db/queries>` |
+ :doc:`QuerySet method reference <ref/models/querysets>`
+
+ * **Model instances:**
+ :doc:`Instance methods <ref/models/instances>` |
+ :doc:`Accessing related objects <ref/models/relations>`
+
+ * **Advanced:**
+ :doc:`Managers <topics/db/managers>` |
+ :doc:`Raw SQL <topics/db/sql>` |
+ :doc:`Transactions <topics/db/transactions>` |
+ :doc:`Aggregation <topics/db/aggregation>` |
+ :doc:`Custom fields <howto/custom-model-fields>` |
+ :doc:`Multiple databases <topics/db/multi-db>`
+
+ * **Other:**
+ :doc:`Supported databases <ref/databases>` |
+ :doc:`Legacy databases <howto/legacy-databases>` |
+ :doc:`Providing initial data <howto/initial-data>` |
+ :doc:`Optimize database access <topics/db/optimization>`
+
+The template layer
+==================
+
+ * **For designers:**
+ :doc:`Syntax overview <topics/templates>` |
+ :doc:`Built-in tags and filters <ref/templates/builtins>`
+
+ * **For programmers:**
+ :doc:`Template API <ref/templates/api>` |
+ :doc:`Custom tags and filters <howto/custom-template-tags>`
+
+The view layer
+==============
+
+ * **The basics:**
+ :doc:`URLconfs <topics/http/urls>` |
+ :doc:`View functions <topics/http/views>` |
+ :doc:`Shortcuts <topics/http/shortcuts>`
+
+ * **Reference:** :doc:`Request/response objects <ref/request-response>`
+
+ * **File uploads:**
+ :doc:`Overview <topics/http/file-uploads>` |
+ :doc:`File objects <ref/files/file>` |
+ :doc:`Storage API <ref/files/storage>` |
+ :doc:`Managing files <topics/files>` |
+ :doc:`Custom storage <howto/custom-file-storage>`
+
+ * **Generic views:**
+ :doc:`Overview<topics/generic-views>` |
+ :doc:`Built-in generic views<ref/generic-views>`
+
+ * **Advanced:**
+ :doc:`Generating CSV <howto/outputting-csv>` |
+ :doc:`Generating PDF <howto/outputting-pdf>`
+
+ * **Middleware:**
+ :doc:`Overview <topics/http/middleware>` |
+ :doc:`Built-in middleware classes <ref/middleware>`
+
+Forms
+=====
+
+ * **The basics:**
+ :doc:`Overview <topics/forms/index>` |
+ :doc:`Form API <ref/forms/api>` |
+ :doc:`Built-in fields <ref/forms/fields>` |
+ :doc:`Built-in widgets <ref/forms/widgets>`
+
+ * **Advanced:**
+ :doc:`Forms for models <topics/forms/modelforms>` |
+ :doc:`Integrating media <topics/forms/media>` |
+ :doc:`Formsets <topics/forms/formsets>` |
+ :doc:`Customizing validation <ref/forms/validation>`
+
+ * **Extras:**
+ :doc:`Form preview <ref/contrib/formtools/form-preview>` |
+ :doc:`Form wizard <ref/contrib/formtools/form-wizard>`
+
+The development process
+=======================
+
+ * **Settings:**
+ :doc:`Overview <topics/settings>` |
+ :doc:`Full list of settings <ref/settings>`
+
+ * **Exceptions:**
+ :doc:`Overview <ref/exceptions>`
+
+ * **django-admin.py and manage.py:**
+ :doc:`Overview <ref/django-admin>` |
+ :doc:`Adding custom commands <howto/custom-management-commands>`
+
+ * **Testing:** :doc:`Overview <topics/testing>`
+
+ * **Deployment:**
+ :doc:`Overview <howto/deployment/index>` |
+ :doc:`Apache/mod_wsgi <howto/deployment/modwsgi>` |
+ :doc:`Apache/mod_python <howto/deployment/modpython>` |
+ :doc:`FastCGI/SCGI/AJP <howto/deployment/fastcgi>` |
+ :doc:`Apache authentication <howto/apache-auth>` |
+ :doc:`Serving static files <howto/static-files>` |
+ :doc:`Tracking code errors by e-mail <howto/error-reporting>`
+
+Other batteries included
+========================
+
+ * :doc:`Admin site <ref/contrib/admin/index>` | :doc:`Admin actions <ref/contrib/admin/actions>` | :doc:`Admin documentation generator<ref/contrib/admin/admindocs>`
+ * :doc:`Authentication <topics/auth>`
+ * :doc:`Cache system <topics/cache>`
+ * :doc:`Conditional content processing <topics/conditional-view-processing>`
+ * :doc:`Comments <ref/contrib/comments/index>` | :doc:`Moderation <ref/contrib/comments/moderation>` | :doc:`Custom comments <ref/contrib/comments/custom>`
+ * :doc:`Content types <ref/contrib/contenttypes>`
+ * :doc:`Cross Site Request Forgery protection <ref/contrib/csrf>`
+ * :doc:`Databrowse <ref/contrib/databrowse>`
+ * :doc:`E-mail (sending) <topics/email>`
+ * :doc:`Flatpages <ref/contrib/flatpages>`
+ * :doc:`GeoDjango <ref/contrib/gis/index>`
+ * :doc:`Humanize <ref/contrib/humanize>`
+ * :doc:`Internationalization <topics/i18n/index>`
+ * :doc:`Jython support <howto/jython>`
+ * :doc:`"Local flavor" <ref/contrib/localflavor>`
+ * :doc:`Messages <ref/contrib/messages>`
+ * :doc:`Pagination <topics/pagination>`
+ * :doc:`Redirects <ref/contrib/redirects>`
+ * :doc:`Serialization <topics/serialization>`
+ * :doc:`Sessions <topics/http/sessions>`
+ * :doc:`Signals <topics/signals>`
+ * :doc:`Sitemaps <ref/contrib/sitemaps>`
+ * :doc:`Sites <ref/contrib/sites>`
+ * :doc:`Syndication feeds (RSS/Atom) <ref/contrib/syndication>`
+ * :doc:`Unicode in Django <ref/unicode>`
+ * :doc:`Web design helpers <ref/contrib/webdesign>`
+ * :doc:`Validators <ref/validators>`
+
+The Django open-source project
+==============================
+
+ * **Community:**
+ :doc:`How to get involved <internals/contributing>` |
+ :doc:`The release process <internals/release-process>` |
+ :doc:`Team of committers <internals/committers>` |
+ :doc:`The Django source code repository <internals/svn>`
+
+ * **Design philosophies:**
+ :doc:`Overview <misc/design-philosophies>`
+
+ * **Documentation:**
+ :doc:`About this documentation <internals/documentation>`
+
+ * **Third-party distributions:**
+ :doc:`Overview <misc/distributions>`
+
+ * **Django over time:**
+ :doc:`API stability <misc/api-stability>` |
+ :doc:`Release notes and upgrading instructions <releases/index>` |
+ :doc:`Deprecation Timeline <internals/deprecation>`