From 4b459cfdab27be1547a8407f72d8db790a8f6cf7 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Mon, 7 Nov 2016 21:12:25 -0500 Subject: [PATCH] Rename some sections, some normalization --- docs/dev/tests.txt | 5 +++-- docs/guide/install.txt | 5 +++-- docs/guide/migration.txt | 1 + docs/guide/rest_framework.txt | 5 +++-- docs/guide/usage.txt | 5 +++-- docs/ref/fields.txt | 5 +++-- docs/ref/filters.txt | 1 + docs/ref/filterset.txt | 5 +++-- docs/ref/settings.txt | 4 +--- docs/ref/widgets.txt | 1 + 10 files changed, 22 insertions(+), 15 deletions(-) diff --git a/docs/dev/tests.txt b/docs/dev/tests.txt index fa22bf6..5da22d1 100644 --- a/docs/dev/tests.txt +++ b/docs/dev/tests.txt @@ -1,5 +1,6 @@ -Running the django-filter tests -=============================== +====================== +Running the Test Suite +====================== The easiest way to run the django-filter tests is to check out the source code into a virtualenv, where you can install the test dependencies. diff --git a/docs/guide/install.txt b/docs/guide/install.txt index 044e55e..7e940ea 100644 --- a/docs/guide/install.txt +++ b/docs/guide/install.txt @@ -1,5 +1,6 @@ -Installing django-filter ------------------------- +============ +Installation +============ Install with pip: diff --git a/docs/guide/migration.txt b/docs/guide/migration.txt index aa2f8ec..8448e9f 100644 --- a/docs/guide/migration.txt +++ b/docs/guide/migration.txt @@ -1,3 +1,4 @@ +================ Migrating to 1.0 ================ diff --git a/docs/guide/rest_framework.txt b/docs/guide/rest_framework.txt index b3f2f4d..a218f0e 100644 --- a/docs/guide/rest_framework.txt +++ b/docs/guide/rest_framework.txt @@ -1,5 +1,6 @@ -Django Rest Framework -===================== +==================== +Integration with DRF +==================== Integration with `Django Rest Framework`__ is provided through a DRF-specific ``FilterSet`` and a `filter backend`__. These may be found in the ``rest_framework`` sub-package. diff --git a/docs/guide/usage.txt b/docs/guide/usage.txt index 180b652..09f3397 100644 --- a/docs/guide/usage.txt +++ b/docs/guide/usage.txt @@ -1,5 +1,6 @@ -Using django-filter -=================== +=============== +Getting Started +=============== Django-filter provides a simple way to filter down a queryset based on parameters a user provides. Say we have a ``Product`` model and we want to let diff --git a/docs/ref/fields.txt b/docs/ref/fields.txt index 940724f..9640917 100644 --- a/docs/ref/fields.txt +++ b/docs/ref/fields.txt @@ -1,5 +1,6 @@ -Fields Reference -================ +=============== +Field Reference +=============== ``IsoDateTimeField`` ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/ref/filters.txt b/docs/ref/filters.txt index 0d3c1b4..69bec4d 100644 --- a/docs/ref/filters.txt +++ b/docs/ref/filters.txt @@ -1,3 +1,4 @@ +================ Filter Reference ================ diff --git a/docs/ref/filterset.txt b/docs/ref/filterset.txt index a4d851b..26b8cd9 100644 --- a/docs/ref/filterset.txt +++ b/docs/ref/filterset.txt @@ -1,5 +1,6 @@ -FilterSet Guide -=============== +================= +FilterSet Options +================= This document provides a guide on using additional FilterSet features. diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 442b24e..e3f721d 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1,7 +1,5 @@ -.. _ref-settings: - ================== -Available Settings +Settings Reference ================== Here is a list of all available settings of django-filters and their diff --git a/docs/ref/widgets.txt b/docs/ref/widgets.txt index d054c58..89f4e44 100644 --- a/docs/ref/widgets.txt +++ b/docs/ref/widgets.txt @@ -1,3 +1,4 @@ +================ Widget Reference ================