Include top-level git.refresh in API Reference

For gitpython-developers#1854.
EliahKagan · Mar 2, 2024 · 7044ff6 · 7044ff6
1 parent fc59e5e
commit 7044ff6
Showing 1 changed file with 21 additions and 18 deletions.
diff --git a/doc/source/reference.rst b/doc/source/reference.rst
@@ -3,37 +3,40 @@
 API Reference
 =============
 
-Version
--------
+Top-Level
+---------
 
 .. py:data:: git.__version__
 
    Current GitPython version.
 
+.. automodule:: git
+   :members: refresh
+
 Objects.Base
 ------------
 
 .. automodule:: git.objects.base
    :members:
    :undoc-members:
    :special-members:
- 
+
 Objects.Blob
 ------------
 
 .. automodule:: git.objects.blob
    :members:
    :undoc-members:
    :special-members:
-   
+
 Objects.Commit
 --------------
 
 .. automodule:: git.objects.commit
    :members:
    :undoc-members:
    :special-members:
-   
+
 Objects.Tag
 -----------
 
@@ -73,15 +76,15 @@ Objects.Submodule.root
    :members:
    :undoc-members:
    :special-members:
-   
+
 Objects.Submodule.util
 ----------------------
 
 .. automodule:: git.objects.submodule.util
    :members:
    :undoc-members:
    :special-members:
-   
+
 Objects.Util
 -------------
 
@@ -105,23 +108,23 @@ Index.Functions
    :members:
    :undoc-members:
    :special-members:
-   
+
 Index.Types
 -----------
 
 .. automodule:: git.index.typ
    :members:
    :undoc-members:
    :special-members:
-   
+
 Index.Util
 -------------
 
 .. automodule:: git.index.util
    :members:
    :undoc-members:
    :special-members:
-   
+
 GitCmd
 ------
 
@@ -137,7 +140,7 @@ Config
    :members:
    :undoc-members:
    :special-members:
-   
+
 Diff
 ----
 
@@ -154,15 +157,15 @@ Exceptions
    :undoc-members:
    :special-members:
 
- 
+
 Refs.symbolic
 -------------
 
 .. automodule:: git.refs.symbolic
    :members:
    :undoc-members:
    :special-members:
-   
+
 Refs.reference
 --------------
 
@@ -178,31 +181,31 @@ Refs.head
    :members:
    :undoc-members:
    :special-members:
-   
+
 Refs.tag
 ------------
 
 .. automodule:: git.refs.tag
    :members:
    :undoc-members:
    :special-members:
-   
+
 Refs.remote
 ------------
 
 .. automodule:: git.refs.remote
    :members:
    :undoc-members:
    :special-members:
-   
+
 Refs.log
 ------------
 
 .. automodule:: git.refs.log
    :members:
    :undoc-members:
    :special-members:
-   
+
 Remote
 ------
 
@@ -218,7 +221,7 @@ Repo.Base
    :members:
    :undoc-members:
    :special-members:
-   
+
 Repo.Functions
 --------------