Improve documentation on indexing

Update installation.md

README.md

@@ -18,7 +18,7 @@ This fork contains is a continuation of the work done by [`mariocesar`](https://
 ## Install
 
 
- Please remember to uninstall `django-ltree` before installing `django-ltree-2`, since both uses `django_ltree` namespace.
+Please remember to uninstall `django-ltree` before installing `django-ltree-2`, since both uses `django_ltree` namespace.
 
 
 ---

docs/index.rst

@@ -14,6 +14,7 @@ Augmenting `django` orm with postgres `ltree <https://www.postgresql.org/docs/cu
 
    installation
    usage
+   indexes
    manager
 
 Indices and tables

docs/indexes.md

@@ -0,0 +1,25 @@
+# Indexes
+
+If you want to add index to your `TreeModel`, use [`GistIndex`](https://docs.djangoproject.com/en/5.1/ref/contrib/postgres/indexes/#gistindex) from [`postgres`](https://www.postgresql.org/docs/9.1/textsearch-indexes.html).
+
+```{note}
+Note: `GistIndex` was suggested based on [`@pauloxnet`](http://github.com/pauloxnet)'s code sample from this [microsoft citus con youtube video](https://www.youtube.com/watch?v=u8F7bTJVe_4&t=1051s)
+
+```
+
+To implement the index in your model:
+
+```{code-block} python
+:caption: models.py
+
+from django.contrib.postgres import indexes as idx
+from django_ltree import TreeModel
+
+class CustomTree(TreeModel):
+    ...
+
+    class Meta:
+        indexes = [
+            idx.GistIndex(fields=["path"]),
+        ]
+```

docs/installation.md

@@ -8,16 +8,21 @@ Django 4.2 to 5.0 supported.
 
 ## Installation
 
+```{attention}
+Please remember to uninstall `django-ltree` before installing `django-ltree-2`, since both uses `django_ltree` namespace.
+```
+
 1.  Install with **pip**:
 
-```sh
+```bash
 python -m pip install django-ltree-2
 ```
 
 2.  Add django-ltree to your `INSTALLED_APPS`:
 
-```python
-# settings.py
+```{code-block} python
+:caption: settings.py
+
 INSTALLED_APPS = [
     ...,
     "django_ltree",

docs/usage.md

@@ -2,8 +2,9 @@
 
 Lets assume that our model looks like this.
 
-```python
-# models.py
+```{code-block} python
+:caption: models.py
+
 from django import models
 from django_ltree import TreeModel
 
@@ -13,7 +14,9 @@ class CustomTree(TreeModel):
 
 ## Create a child without parent
 
-```python
+```{code-block} python
+:caption: views.py
+
 from .models import CustomTree
 
 CustomTree.objects.create_child(text='Hello world')
@@ -26,7 +29,9 @@ tree)
 
 Let's assume we want to add a child to the CustomTree object of `pk=1`
 
-```python
+```{code-block} python
+:caption: views.py
+
 from .models import CustomTree
 
 # This must return a single object
@@ -38,7 +43,9 @@ CustomTree.objects.create_child(text='Hello world', parent=parent)
 
 A root means the the object that childrens anchor to.
 
-```python
+```{code-block} python
+:caption: views.py
+
 from .models import CustomTree
 
 roots: list[CustomTree] = CustomTree.objects.roots()
@@ -49,7 +56,9 @@ roots: list[CustomTree] = CustomTree.objects.roots()
 To get the childrens of a object, we can first get the object then call
 the QuerySet specific children function.
 
-```python
+```{code-block} python
+:caption: views.py
+
 from .models import CustomTree
 
 instance = CustomTree.objects.get(pk=1)
@@ -65,7 +74,9 @@ the filter method.
 Lets assume we want to get the childrens of `CustomTree`
 object whose pk is 1.
 
-```python
+```{code-block} python
+:caption: views.py
+
 from .models import CustomTree
 
 instance = CustomTree.objects.get(pk=1)

pyproject.toml

@@ -7,10 +7,13 @@ authors = [
     "Mario César Señoranis Ayala <mariocesar@humanzilla.com>",
     "Kimsia Sim",
 ]
+maintainers = [
+    "baseplate-admin <61817579+baseplate-admin@users.noreply.github.com>",
+]
 license = "MIT"
 readme = "README.md"
-packages = [{include = "django_ltree"}]
-classifiers = [ 
+packages = [{ include = "django_ltree", from = "src" }]
+classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Framework :: Django",
     "Framework :: Django :: 3.2",