From 6e07ec3f655073bebdf1b1dfd2303e91202e14e1 Mon Sep 17 00:00:00 2001
From: Akshesh <aksheshdoshi@gmail.com>
Date: Mon, 8 Aug 2016 17:20:25 +0530
Subject: Fixed #27030 -- Added contrib.postgres.indexes.GinIndex.

---
 docs/ref/contrib/postgres/index.txt   |  1 +
 docs/ref/contrib/postgres/indexes.txt | 24 ++++++++++++++++++++++++
 docs/ref/models/indexes.txt           |  5 +++++
 3 files changed, 30 insertions(+)
 create mode 100644 docs/ref/contrib/postgres/indexes.txt

(limited to 'docs/ref')

diff --git a/docs/ref/contrib/postgres/index.txt b/docs/ref/contrib/postgres/index.txt
index d04ed14889..5a212fbdcd 100644
--- a/docs/ref/contrib/postgres/index.txt
+++ b/docs/ref/contrib/postgres/index.txt
@@ -35,6 +35,7 @@ release. Some fields require higher versions.
     fields
     forms
     functions
+    indexes
     lookups
     operations
     search
diff --git a/docs/ref/contrib/postgres/indexes.txt b/docs/ref/contrib/postgres/indexes.txt
new file mode 100644
index 0000000000..7bf26fb117
--- /dev/null
+++ b/docs/ref/contrib/postgres/indexes.txt
@@ -0,0 +1,24 @@
+=================================
+PostgreSQL specific model indexes
+=================================
+
+.. module:: django.contrib.postgres.indexes
+
+.. versionadded:: 1.11
+
+The following are PostgreSQL specific :doc:`indexes </ref/models/indexes>`
+available from the ``django.contrib.postgres.indexes`` module.
+
+``GinIndex``
+============
+
+.. class:: GinIndex()
+
+    Creates a `gin index
+    <https://www.postgresql.org/docs/current/static/gin.html>`_.
+
+    To use this index, you need to activate the `btree_gin extension
+    <https://www.postgresql.org/docs/current/static/btree-gin.html>`_ on
+    PostgreSQL. You can install it using the
+    :class:`~django.contrib.postgres.operations.BtreeGinExtension` migration
+    operation.
diff --git a/docs/ref/models/indexes.txt b/docs/ref/models/indexes.txt
index ac2839bbd4..999513c9d6 100644
--- a/docs/ref/models/indexes.txt
+++ b/docs/ref/models/indexes.txt
@@ -56,3 +56,8 @@ case, a descending index is created as a normal index.
 The name of the index. If ``name`` isn't provided Django will auto-generate a
 name. For compatibility with different databases, index names cannot be longer
 than 30 characters and shouldn't start with a number (0-9) or underscore (_).
+
+.. seealso::
+
+    For a list of PostgreSQL-specific indexes, see
+    :mod:`django.contrib.postgres.indexes`.
-- 
cgit v1.3