Skip to content

Commit

Permalink
Fixed #9465 -- Simplified API Reference documentation titles for easi…
Browse files Browse the repository at this point in the history
…er 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
  • Loading branch information
gdub committed Dec 26, 2009
1 parent 39122c8 commit c6fa493
Show file tree
Hide file tree
Showing 14 changed files with 43 additions and 33 deletions.
8 changes: 4 additions & 4 deletions docs/ref/authbackends.txt
@@ -1,14 +1,14 @@
.. _ref-authentication-backends: .. _ref-authentication-backends:


========================================== =======================
Built-in authentication backends reference Authentication backends
========================================== =======================


.. module:: django.contrib.auth.backends .. module:: django.contrib.auth.backends
:synopsis: Django's built-in authentication backend classes. :synopsis: Django's built-in authentication backend classes.


This document details the authentication backends that come with Django. For 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 backends, see the :ref:`Other authentication sources section
<authentication-backends>` of the :ref:`User authentication guide <authentication-backends>` of the :ref:`User authentication guide
<topics-auth>`. <topics-auth>`.
Expand Down
6 changes: 3 additions & 3 deletions docs/ref/contrib/index.txt
@@ -1,8 +1,8 @@
.. _ref-contrib-index: .. _ref-contrib-index:


============================ ====================
The "django.contrib" add-ons ``contrib`` packages
============================ ====================


Django aims to follow Python's `"batteries included" philosophy`_. It ships Django aims to follow Python's `"batteries included" philosophy`_. It ships
with a variety of extra, optional tools that solve common Web-development with a variety of extra, optional tools that solve common Web-development
Expand Down
6 changes: 3 additions & 3 deletions docs/ref/databases.txt
@@ -1,8 +1,8 @@
.. _ref-databases: .. _ref-databases:


=============================== =========
Notes about supported databases Databases
=============================== =========


Django attempts to support as many features as possible on all database 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 backends. However, not all database backends are alike, and we've had to make
Expand Down
9 changes: 5 additions & 4 deletions docs/ref/files/index.txt
@@ -1,13 +1,14 @@
.. _ref-files-index: .. _ref-files-index:


File handling reference =============
======================= File handling
=============


.. module:: django.core.files .. module:: django.core.files
:synopsis: File handling and storage :synopsis: File handling and storage


.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

file file
storage storage
5 changes: 3 additions & 2 deletions docs/ref/forms/index.txt
@@ -1,14 +1,15 @@
.. _ref-forms-index: .. _ref-forms-index:


=====
Forms Forms
===== =====


Detailed form API reference. For introductory material, see :ref:`topics-forms-index`. Detailed form API reference. For introductory material, see :ref:`topics-forms-index`.


.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

api api
fields fields
widgets widgets
validation validation
1 change: 0 additions & 1 deletion docs/ref/generic-views.txt
Expand Up @@ -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 variable's name depends on the ``template_object_name`` parameter, which
is ``'object'`` by default. If ``template_object_name`` is ``'foo'``, is ``'object'`` by default. If ``template_object_name`` is ``'foo'``,
this variable's name will be ``foo``. this variable's name will be ``foo``.

2 changes: 1 addition & 1 deletion docs/ref/index.txt
@@ -1,5 +1,6 @@
.. _ref-index: .. _ref-index:


=============
API Reference API Reference
============= =============


Expand All @@ -20,4 +21,3 @@ API Reference
signals signals
templates/index templates/index
unicode unicode

10 changes: 5 additions & 5 deletions docs/ref/middleware.txt
@@ -1,8 +1,8 @@
.. _ref-middleware: .. _ref-middleware:


============================= ==========
Built-in middleware reference Middleware
============================= ==========


.. module:: django.middleware .. module:: django.middleware
:synopsis: Django's built-in middleware classes. :synopsis: Django's built-in middleware classes.
Expand Down Expand Up @@ -149,8 +149,8 @@ Message middleware


.. versionadded:: 1.2 .. versionadded:: 1.2
``MessageMiddleware`` was added. ``MessageMiddleware`` was added.

Enables cookie- and session-based message support. See the Enables cookie- and session-based message support. See the
:ref:`messages documentation <ref-contrib-messages>`. :ref:`messages documentation <ref-contrib-messages>`.


Session middleware Session middleware
Expand Down
1 change: 1 addition & 0 deletions docs/ref/models/index.txt
@@ -1,5 +1,6 @@
.. _ref-models-index: .. _ref-models-index:


======
Models Models
====== ======


Expand Down
1 change: 0 additions & 1 deletion docs/ref/request-response.txt
Expand Up @@ -598,4 +598,3 @@ types of HTTP responses. Like ``HttpResponse``, these subclasses live in
.. class:: HttpResponseServerError .. class:: HttpResponseServerError


Acts just like :class:`HttpResponse` but uses a 500 status code. Acts just like :class:`HttpResponse` but uses a 500 status code.

8 changes: 8 additions & 0 deletions docs/ref/settings.txt
@@ -1,5 +1,13 @@
.. _ref-settings: .. _ref-settings:


========
Settings
========

.. contents::
:local:
:depth: 1

Available settings Available settings
================== ==================


Expand Down
6 changes: 3 additions & 3 deletions docs/ref/signals.txt
@@ -1,8 +1,8 @@
.. _ref-signals: .. _ref-signals:


========================= =======
Built-in signal reference Signals
========================= =======


A list of all the signals that Django sends. A list of all the signals that Django sends.


Expand Down
7 changes: 4 additions & 3 deletions docs/ref/templates/index.txt
@@ -1,7 +1,8 @@
.. _ref-templates-index: .. _ref-templates-index:


Template reference =========
================== Templates
=========


Django's template engine provides a powerful mini-language for defining the Django's template engine provides a powerful mini-language for defining the
user-facing layer of your application, encouraging a clean separation of user-facing layer of your application, encouraging a clean separation of
Expand All @@ -17,4 +18,4 @@ an understanding of HTML; no knowledge of Python is required.
.. seealso:: .. seealso::


For information on writing your own custom tags and filters, see For information on writing your own custom tags and filters, see
:ref:`howto-custom-template-tags`. :ref:`howto-custom-template-tags`.
6 changes: 3 additions & 3 deletions docs/ref/unicode.txt
@@ -1,8 +1,8 @@
.. _ref-unicode: .. _ref-unicode:


====================== ============
Unicode data in Django Unicode data
====================== ============


.. versionadded:: 1.0 .. versionadded:: 1.0


Expand Down

0 comments on commit c6fa493

Please sign in to comment.