Fixed #17638 -- Added crosslinks between topic and reference guides.

Thanks oinopion for the suggestion and jarus for the initial patch.
This commit is contained in:
Duane Hilton 2014-09-27 16:12:34 -06:00 committed by Tim Graham
parent 90761d00e3
commit 054bdfeff1
11 changed files with 42 additions and 7 deletions

View File

@ -2,8 +2,8 @@
Built-in Class-based views API Built-in Class-based views API
============================== ==============================
Class-based views API reference. For introductory material, see Class-based views API reference. For introductory material, see the
:doc:`/topics/class-based-views/index`. :doc:`/topics/class-based-views/index` topic guide.
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3

View File

@ -1,6 +1,9 @@
==================== =================
Formset Functions Formset Functions
==================== =================
Formset API reference. For introductory material about formsets, see the
:doc:`/topics/forms/formsets` topic guide.
.. module:: django.forms.formsets .. module:: django.forms.formsets
:synopsis: Django's functions for building formsets. :synopsis: Django's functions for building formsets.

View File

@ -2,7 +2,8 @@
Forms Forms
===== =====
Detailed form API reference. For introductory material, see :doc:`/topics/forms/index`. Detailed form API reference. For introductory material, see the
:doc:`/topics/forms/index` topic guide.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -2,6 +2,9 @@
Model Form Functions Model Form Functions
==================== ====================
Model Form API reference. For introductory material about model forms, see the
:doc:`/topics/forms/modelforms` topic guide.
.. module:: django.forms.models .. module:: django.forms.models
:synopsis: Django's functions for building model forms and formsets. :synopsis: Django's functions for building model forms and formsets.

View File

@ -28,6 +28,9 @@ output incorrect code.
All of the core Django operations are available from the All of the core Django operations are available from the
``django.db.migrations.operations`` module. ``django.db.migrations.operations`` module.
For introductory material, see the :doc:`migrations topic guide
</topics/migrations>`.
Schema Operations Schema Operations
================= =================

View File

@ -18,7 +18,8 @@ Core settings
Here's a list of settings available in Django core and their default values. Here's a list of settings available in Django core and their default values.
Settings provided by contrib apps are listed below, followed by a topical index Settings provided by contrib apps are listed below, followed by a topical index
of the core settings. of the core settings. For introductory material, see the :doc:`settings topic
guide </topics/settings>`.
.. setting:: ABSOLUTE_URL_OVERRIDES .. setting:: ABSOLUTE_URL_OVERRIDES

View File

@ -5,7 +5,8 @@ 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
application and presentation logic. Templates can be maintained by anyone with application and presentation logic. Templates can be maintained by anyone with
an understanding of HTML; no knowledge of Python is required. an understanding of HTML; no knowledge of Python is required. For introductory
material, see :doc:`/topics/templates` topic guide.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

View File

@ -1374,3 +1374,9 @@ different database tables).
Django will raise a :exc:`~django.core.exceptions.FieldError` if you override Django will raise a :exc:`~django.core.exceptions.FieldError` if you override
any model field in any ancestor model. any model field in any ancestor model.
.. seealso::
:doc:`The Models Reference </ref/models/index>`
Covers all the model related APIs including model fields, related
objects, and ``QuerySet``.

View File

@ -667,3 +667,9 @@ your Django migrations in the ``migrations`` directory.
More information is available in the More information is available in the
`South 1.0 release notes <http://south.readthedocs.org/en/latest/releasenotes/1.0.html#library-migration-path>`_. `South 1.0 release notes <http://south.readthedocs.org/en/latest/releasenotes/1.0.html#library-migration-path>`_.
.. seealso::
:doc:`The Migrations Operations Reference </ref/migration-operations>`
Covers the schema operations API, special operations, and writing your
own operations.

View File

@ -267,3 +267,8 @@ It boils down to this: Use exactly one of either ``configure()`` or
``DJANGO_SETTINGS_MODULE``. Not both, and not neither. ``DJANGO_SETTINGS_MODULE``. Not both, and not neither.
.. _@login_required: ../authentication/#the-login-required-decorator .. _@login_required: ../authentication/#the-login-required-decorator
.. seealso::
:doc:`The Settings Reference </ref/settings>`
Contains the complete list of core and contrib app settings.

View File

@ -693,3 +693,9 @@ access to the humanize template tags and filters. The child template is
responsible for its own ``{% load humanize %}``. responsible for its own ``{% load humanize %}``.
This is a feature for the sake of maintainability and sanity. This is a feature for the sake of maintainability and sanity.
.. seealso::
:doc:`The Templates Reference </ref/templates/index>`
Covers built-in tags, built-in filters, using an alternative template,
language, and more.