Document GIT_STATUS_

Fixes #509

Author: jdavid

CHANGELOG.rst

@@ -10,12 +10,14 @@
 - Drop support for PyPy3 7.2
 
 - Documentation
+  `#509 <https://github.com/libgit2/pygit2/issues/509>`_
   `#752 <https://github.com/libgit2/pygit2/issues/752>`_
   `#1037 <https://github.com/libgit2/pygit2/issues/1037>`_
 
 - ``Repository.__init__(...)`` now takes flags eg ``GIT_REPOSITORY_OPEN_BARE``,
-   new ``GIT_REPOSITORY_OPEN_*`` constants
-   `#1044 <https://github.com/libgit2/pygit2/pull/1044>`_
+  new ``GIT_REPOSITORY_OPEN_*`` constants
+  `#1044 <https://github.com/libgit2/pygit2/pull/1044>`_
+
 
 1.3.0 (2020-09-18)
 -------------------------

docs/index_file.rst

@@ -54,16 +54,44 @@ The IndexEntry type
 Status
 ====================
 
-.. automethod:: pygit2.Repository.status
-.. automethod:: pygit2.Repository.status_file
+.. autoclass:: pygit2.Repository
+   :members: status_file
+   :noindex:
+
+   .. automethod:: Repository.status
+
+      Example, inspect the status of the repository::
+
+        from pygit2 import GIT_STATUS_CURRENT
+        status = repo.status()
+        for filepath, flags in status.items():
+            if flags != GIT_STATUS_CURRENT:
+                print("Filepath %s isn't clean" % filepath)
+
+This is the list of status flags for a single file::
+
+    GIT_STATUS_CURRENT
+    GIT_STATUS_INDEX_NEW
+    GIT_STATUS_INDEX_MODIFIED
+    GIT_STATUS_INDEX_DELETED
+    GIT_STATUS_INDEX_RENAMED
+    GIT_STATUS_INDEX_TYPECHANGE
+    GIT_STATUS_WT_NEW
+    GIT_STATUS_WT_MODIFIED
+    GIT_STATUS_WT_DELETED
+    GIT_STATUS_WT_TYPECHANGE
+    GIT_STATUS_WT_RENAMED
+    GIT_STATUS_WT_UNREADABLE
+    GIT_STATUS_IGNORED
+    GIT_STATUS_CONFLICTED
+
+A combination of these values will be returned to indicate the status of a
+file.  Status compares the working directory, the index, and the current HEAD
+of the repository.  The `GIT_STATUS_INDEX` set of flags represents the status
+of file in the index relative to the HEAD, and the `GIT_STATUS_WT` set of flags
+represent the status of the file in the working directory relative to the
+index.
 
-Inspect the status of the repository::
-
-    >>> from pygit2 import GIT_STATUS_CURRENT
-    >>> status = repo.status()
-    >>> for filepath, flags in status.items():
-    ...     if flags != GIT_STATUS_CURRENT:
-    ...         print("Filepath %s isn't clean" % filepath)
 
 
 Checkout