From c6fa4936b327f969cfd87517af2aa7c17980b0be Mon Sep 17 00:00:00 2001 From: Gary Wilson Jr Date: Sat, 26 Dec 2009 03:44:21 +0000 Subject: [PATCH] Fixed #9465 -- Simplified API Reference documentation titles for easier lookup and made first-level heading styles consistent. Thanks, adamnelson. git-svn-id: http://code.djangoproject.com/svn/django/trunk@11990 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/ref/authbackends.txt | 8 ++++---- docs/ref/contrib/index.txt | 6 +++--- docs/ref/databases.txt | 6 +++--- docs/ref/files/index.txt | 9 +++++---- docs/ref/forms/index.txt | 5 +++-- docs/ref/generic-views.txt | 1 - docs/ref/index.txt | 2 +- docs/ref/middleware.txt | 10 +++++----- docs/ref/models/index.txt | 1 + docs/ref/request-response.txt | 1 - docs/ref/settings.txt | 8 ++++++++ docs/ref/signals.txt | 6 +++--- docs/ref/templates/index.txt | 7 ++++--- docs/ref/unicode.txt | 6 +++--- 14 files changed, 43 insertions(+), 33 deletions(-) diff --git a/docs/ref/authbackends.txt b/docs/ref/authbackends.txt index 7cb54df7ea..0e98c21b21 100644 --- a/docs/ref/authbackends.txt +++ b/docs/ref/authbackends.txt @@ -1,14 +1,14 @@ .. _ref-authentication-backends: -========================================== -Built-in authentication backends reference -========================================== +======================= +Authentication backends +======================= .. module:: django.contrib.auth.backends :synopsis: Django's built-in authentication backend classes. This document details the authentication backends that come with Django. For -information on how how to use them and how to write your own authentication +information on how to use them and how to write your own authentication backends, see the :ref:`Other authentication sources section ` of the :ref:`User authentication guide `. diff --git a/docs/ref/contrib/index.txt b/docs/ref/contrib/index.txt index a8e1427678..7b07f920ae 100644 --- a/docs/ref/contrib/index.txt +++ b/docs/ref/contrib/index.txt @@ -1,8 +1,8 @@ .. _ref-contrib-index: -============================ -The "django.contrib" add-ons -============================ +==================== +``contrib`` packages +==================== Django aims to follow Python's `"batteries included" philosophy`_. It ships with a variety of extra, optional tools that solve common Web-development diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt index 8b473da821..df8c64c97e 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -1,8 +1,8 @@ .. _ref-databases: -=============================== -Notes about supported databases -=============================== +========= +Databases +========= Django attempts to support as many features as possible on all database backends. However, not all database backends are alike, and we've had to make diff --git a/docs/ref/files/index.txt b/docs/ref/files/index.txt index bdc327b2d7..1d59d5fa23 100644 --- a/docs/ref/files/index.txt +++ b/docs/ref/files/index.txt @@ -1,13 +1,14 @@ .. _ref-files-index: -File handling reference -======================= +============= +File handling +============= .. module:: django.core.files :synopsis: File handling and storage .. toctree:: :maxdepth: 1 - + file - storage \ No newline at end of file + storage diff --git a/docs/ref/forms/index.txt b/docs/ref/forms/index.txt index a9e041c2a7..e310863c7a 100644 --- a/docs/ref/forms/index.txt +++ b/docs/ref/forms/index.txt @@ -1,5 +1,6 @@ .. _ref-forms-index: +===== Forms ===== @@ -7,8 +8,8 @@ Detailed form API reference. For introductory material, see :ref:`topics-forms-i .. toctree:: :maxdepth: 1 - + api fields widgets - validation \ No newline at end of file + validation diff --git a/docs/ref/generic-views.txt b/docs/ref/generic-views.txt index 4752a705a0..af23506505 100644 --- a/docs/ref/generic-views.txt +++ b/docs/ref/generic-views.txt @@ -1088,4 +1088,3 @@ In addition to ``extra_context``, the template's context will be: variable's name depends on the ``template_object_name`` parameter, which is ``'object'`` by default. If ``template_object_name`` is ``'foo'``, this variable's name will be ``foo``. - diff --git a/docs/ref/index.txt b/docs/ref/index.txt index 6cc796d8e4..f1466c3496 100644 --- a/docs/ref/index.txt +++ b/docs/ref/index.txt @@ -1,5 +1,6 @@ .. _ref-index: +============= API Reference ============= @@ -20,4 +21,3 @@ API Reference signals templates/index unicode - diff --git a/docs/ref/middleware.txt b/docs/ref/middleware.txt index b8d3e475c3..27a2d9a95a 100644 --- a/docs/ref/middleware.txt +++ b/docs/ref/middleware.txt @@ -1,8 +1,8 @@ .. _ref-middleware: -============================= -Built-in middleware reference -============================= +========== +Middleware +========== .. module:: django.middleware :synopsis: Django's built-in middleware classes. @@ -149,8 +149,8 @@ Message middleware .. versionadded:: 1.2 ``MessageMiddleware`` was added. - -Enables cookie- and session-based message support. See the + +Enables cookie- and session-based message support. See the :ref:`messages documentation `. Session middleware diff --git a/docs/ref/models/index.txt b/docs/ref/models/index.txt index 6918f335da..64b47b26cc 100644 --- a/docs/ref/models/index.txt +++ b/docs/ref/models/index.txt @@ -1,5 +1,6 @@ .. _ref-models-index: +====== Models ====== diff --git a/docs/ref/request-response.txt b/docs/ref/request-response.txt index 77d991bc1f..7ef42b5f15 100644 --- a/docs/ref/request-response.txt +++ b/docs/ref/request-response.txt @@ -598,4 +598,3 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in .. class:: HttpResponseServerError Acts just like :class:`HttpResponse` but uses a 500 status code. - diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index bd8be27e5f..16dc276b99 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1,5 +1,13 @@ .. _ref-settings: +======== +Settings +======== + +.. contents:: + :local: + :depth: 1 + Available settings ================== diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt index cc203f1817..b54a895000 100644 --- a/docs/ref/signals.txt +++ b/docs/ref/signals.txt @@ -1,8 +1,8 @@ .. _ref-signals: -========================= -Built-in signal reference -========================= +======= +Signals +======= A list of all the signals that Django sends. diff --git a/docs/ref/templates/index.txt b/docs/ref/templates/index.txt index d7bf99aa8c..6655b3da18 100644 --- a/docs/ref/templates/index.txt +++ b/docs/ref/templates/index.txt @@ -1,7 +1,8 @@ .. _ref-templates-index: -Template reference -================== +========= +Templates +========= Django's template engine provides a powerful mini-language for defining the user-facing layer of your application, encouraging a clean separation of @@ -17,4 +18,4 @@ an understanding of HTML; no knowledge of Python is required. .. seealso:: For information on writing your own custom tags and filters, see - :ref:`howto-custom-template-tags`. \ No newline at end of file + :ref:`howto-custom-template-tags`. diff --git a/docs/ref/unicode.txt b/docs/ref/unicode.txt index c5851a2c6c..2f23354914 100644 --- a/docs/ref/unicode.txt +++ b/docs/ref/unicode.txt @@ -1,8 +1,8 @@ .. _ref-unicode: -====================== -Unicode data in Django -====================== +============ +Unicode data +============ .. versionadded:: 1.0