Update some document

Author: virusdefender

.gitignore

@@ -1,7 +1,7 @@
 *.egg-info
 dist/
 build/
-docs/build
+docs/_build
 docs/source/.doctrees/
 __pycache__/
 .cache

docs/source/decorators.rst

@@ -3,7 +3,7 @@ Decorators
 
 Now the decorator must be used on a non-abstract model class that has not yet built a table in the database.
 If you must use the decorator on a model class that has previously performed a migrate operation, you need
-to back up the model's data, then delete the table, and then import the data after you have created a
+to back up the model's data, then drop the table, and then import the data after you have created a
 partitioned table.
 
 .. py:currentmodule:: pg_timepart.manager
@@ -14,5 +14,5 @@ partitioned table.
 Post-Decoration
 ---------------
 
-You can run ``makemigration`` and ``migrate`` commands to create and apply new migrations.
+You can run ``makemigrations`` and ``migrate`` commands to create and apply new migrations.
 Once the table has been created, it is not possible to turn a regular table into a partitioned table or vice versa.

docs/source/design.rst

@@ -17,25 +17,39 @@ Conflict Avoidance
 ------------------
 
 It is important to note that if the field has the ``primary_key`` or ``unique`` attribute set, but it is not a partitioned field, we will ignore the
-`PRIMARY KEY` or `UNIQUE` declarations for that field in the SQL statement generated by Django. Django itself ignores the ``db_index``
+``PRIMARY KEY`` or ``UNIQUE`` declarations for that field in the SQL statement generated by Django. Django itself ignores the ``db_index``
 attribute of such fields, so you cannot use this method to create field indexes.
 
+A workaround is to add a ``indexes`` declaration in your model, for example
+
+.. code-block:: python
+
+    @TimeRangePartitioningSupport("timestamp")
+    class DataTable(models.Model):
+        id = models.BigIntegerField(primary_key=True, serialize=False)
+        timestamp = models.DateTimeField()
+        data = models.TextField()
+
+        class Meta:
+            # If you do not add this line, id field will not have a index
+            indexes = (models.Index(fields=("id", )), )
+
 Tablespace
 ----------
 
-django-partitioning will silently set the tablespace of all local partitioned indexes under one partition to be consistent with
+``pg_timepart`` will silently set the tablespace of all local partitioned indexes under one partition to be consistent with
 the partition.
 
 Partition Information
 ---------------------
 
-django-partitioning persists partition configuration and state information with `PartitionConfig` and `PartitionLog`.
-The problem with this is that once this information is inconsistent with the actual situation, django-partitioning
-will not work properly, and you can only fix it manually.
+``pg_timepart`` saves partition configuration and state information in ``PartitionConfig`` and ``PartitionLog``.
+The problem with this is that once this information is inconsistent with the actual situation, ``pg_timepart``
+will not work properly, so you can only fix it manually.
 
 Management
 ----------
 
 You can use ``Model.partitioning.create_partition`` and ``Model.partitioning.detach_partition`` to automatically create and
-archive partitions. In addition setting `default_detach_tablespace` and `default_attach_tablespace`, you can also use the
+archive partitions. In addition setting ``default_detach_tablespace`` and ``default_attach_tablespace``, you can also use the
 ``set_tablespace`` method of the PartitionLog object to move the partition. See :doc:`api` for details.

docs/source/installation.rst

@@ -1,24 +1,25 @@
 Installation
 ============
 
-GitHub
-------
+PyPI
+----
 
 .. code-block:: bash
 
-   $ pip install git+https://github.com/chaitin/django-pg-timepart.git@master
+   $ pip install django-pg-timepart
 
-PyPI
-----
+Or you can install from GitHub
 
 .. code-block:: bash
 
-   $ pip install django-pg-timepart
+   $ pip install git+https://github.com/chaitin/django-pg-timepart.git@master
 
-Django
-------
+Integrate with Django
+---------------------
 
-settings.py (Important - Please note 'django-partitioning' is loaded earlier than the app that depends on it)::
+Add ``pg_timepart`` to ``INSTALLED_APPS`` in settings.py.
+
+Important - Please note 'pg_timepart' should be loaded earlier than other apps that depend on it::
 
     INSTALLED_APPS = [
         'pg_timepart',
@@ -27,12 +28,13 @@ settings.py (Important - Please note 'django-partitioning' is loaded earlier tha
 
     PARTITION_TIMEZONE = "Asia/Shanghai"
 
-You can specify the time zone referenced by the time range partitioned table via `PARTITION_TIMEZONE`,
-and if it is not specified, get the value of `TIME_ZONE`.
+You can specify the time zone referenced by the time range partitioned table via ``PARTITION_TIMEZONE``,
+and if it is not specified, ``TIME_ZONE`` value is used.
 
 Post-Installation
 -----------------
 
 In your Django root execute the command below to create 'pg_timepart' database tables::
 
     ./manage.py migrate pg_timepart
+