From 054bdfeff113459a48974d08098915431d0a093d Mon Sep 17 00:00:00 2001 From: Duane Hilton Date: Sat, 27 Sep 2014 16:12:34 -0600 Subject: [PATCH] Fixed #17638 -- Added crosslinks between topic and reference guides. Thanks oinopion for the suggestion and jarus for the initial patch. --- docs/ref/class-based-views/index.txt | 4 ++-- docs/ref/forms/formsets.txt | 7 +++++-- docs/ref/forms/index.txt | 3 ++- docs/ref/forms/models.txt | 3 +++ docs/ref/migration-operations.txt | 3 +++ docs/ref/settings.txt | 3 ++- docs/ref/templates/index.txt | 3 ++- docs/topics/db/models.txt | 6 ++++++ docs/topics/migrations.txt | 6 ++++++ docs/topics/settings.txt | 5 +++++ docs/topics/templates.txt | 6 ++++++ 11 files changed, 42 insertions(+), 7 deletions(-) diff --git a/docs/ref/class-based-views/index.txt b/docs/ref/class-based-views/index.txt index 6aae0b0847..fa4288a035 100644 --- a/docs/ref/class-based-views/index.txt +++ b/docs/ref/class-based-views/index.txt @@ -2,8 +2,8 @@ Built-in Class-based views API ============================== -Class-based views API reference. For introductory material, see -:doc:`/topics/class-based-views/index`. +Class-based views API reference. For introductory material, see the +:doc:`/topics/class-based-views/index` topic guide. .. toctree:: :maxdepth: 3 diff --git a/docs/ref/forms/formsets.txt b/docs/ref/forms/formsets.txt index 449e7bf33a..f613b87201 100644 --- a/docs/ref/forms/formsets.txt +++ b/docs/ref/forms/formsets.txt @@ -1,6 +1,9 @@ -==================== +================= Formset Functions -==================== +================= + +Formset API reference. For introductory material about formsets, see the +:doc:`/topics/forms/formsets` topic guide. .. module:: django.forms.formsets :synopsis: Django's functions for building formsets. diff --git a/docs/ref/forms/index.txt b/docs/ref/forms/index.txt index e6edc88ca1..618c705b92 100644 --- a/docs/ref/forms/index.txt +++ b/docs/ref/forms/index.txt @@ -2,7 +2,8 @@ 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:: :maxdepth: 2 diff --git a/docs/ref/forms/models.txt b/docs/ref/forms/models.txt index 99ff9911f1..259dce79f4 100644 --- a/docs/ref/forms/models.txt +++ b/docs/ref/forms/models.txt @@ -2,6 +2,9 @@ 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 :synopsis: Django's functions for building model forms and formsets. diff --git a/docs/ref/migration-operations.txt b/docs/ref/migration-operations.txt index c55ad0afb8..2c5c1bb980 100644 --- a/docs/ref/migration-operations.txt +++ b/docs/ref/migration-operations.txt @@ -28,6 +28,9 @@ output incorrect code. All of the core Django operations are available from the ``django.db.migrations.operations`` module. +For introductory material, see the :doc:`migrations topic guide +`. + Schema Operations ================= diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index aa246125cc..6f2cfefb4b 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -18,7 +18,8 @@ Core settings 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 -of the core settings. +of the core settings. For introductory material, see the :doc:`settings topic +guide `. .. setting:: ABSOLUTE_URL_OVERRIDES diff --git a/docs/ref/templates/index.txt b/docs/ref/templates/index.txt index 0aa4798a94..0e70b7326f 100644 --- a/docs/ref/templates/index.txt +++ b/docs/ref/templates/index.txt @@ -5,7 +5,8 @@ Templates Django's template engine provides a powerful mini-language for defining the user-facing layer of your application, encouraging a clean separation of 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:: :maxdepth: 2 diff --git a/docs/topics/db/models.txt b/docs/topics/db/models.txt index c19893f536..a134a94073 100644 --- a/docs/topics/db/models.txt +++ b/docs/topics/db/models.txt @@ -1374,3 +1374,9 @@ different database tables). Django will raise a :exc:`~django.core.exceptions.FieldError` if you override any model field in any ancestor model. + +.. seealso:: + + :doc:`The Models Reference ` + Covers all the model related APIs including model fields, related + objects, and ``QuerySet``. diff --git a/docs/topics/migrations.txt b/docs/topics/migrations.txt index ce30e0b477..65ae6ac0da 100644 --- a/docs/topics/migrations.txt +++ b/docs/topics/migrations.txt @@ -667,3 +667,9 @@ your Django migrations in the ``migrations`` directory. More information is available in the `South 1.0 release notes `_. + +.. seealso:: + + :doc:`The Migrations Operations Reference ` + Covers the schema operations API, special operations, and writing your + own operations. diff --git a/docs/topics/settings.txt b/docs/topics/settings.txt index 2024d88a0f..edec6c5ad5 100644 --- a/docs/topics/settings.txt +++ b/docs/topics/settings.txt @@ -267,3 +267,8 @@ It boils down to this: Use exactly one of either ``configure()`` or ``DJANGO_SETTINGS_MODULE``. Not both, and not neither. .. _@login_required: ../authentication/#the-login-required-decorator + +.. seealso:: + + :doc:`The Settings Reference ` + Contains the complete list of core and contrib app settings. diff --git a/docs/topics/templates.txt b/docs/topics/templates.txt index bd59c1a33e..083c0c9a10 100644 --- a/docs/topics/templates.txt +++ b/docs/topics/templates.txt @@ -693,3 +693,9 @@ access to the humanize template tags and filters. The child template is responsible for its own ``{% load humanize %}``. This is a feature for the sake of maintainability and sanity. + +.. seealso:: + + :doc:`The Templates Reference ` + Covers built-in tags, built-in filters, using an alternative template, + language, and more.