Skip to content

Commit 7044ff6

Browse files
committed
Include top-level git.refresh in API Reference
For gitpython-developers#1854.
1 parent fc59e5e commit 7044ff6

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

doc/source/reference.rst

+21-18
Original file line numberDiff line numberDiff line change
@@ -3,37 +3,40 @@
33
API Reference
44
=============
55

6-
Version
7-
-------
6+
Top-Level
7+
---------
88

99
.. py:data:: git.__version__
1010
1111
Current GitPython version.
1212

13+
.. automodule:: git
14+
:members: refresh
15+
1316
Objects.Base
1417
------------
1518

1619
.. automodule:: git.objects.base
1720
:members:
1821
:undoc-members:
1922
:special-members:
20-
23+
2124
Objects.Blob
2225
------------
2326

2427
.. automodule:: git.objects.blob
2528
:members:
2629
:undoc-members:
2730
:special-members:
28-
31+
2932
Objects.Commit
3033
--------------
3134

3235
.. automodule:: git.objects.commit
3336
:members:
3437
:undoc-members:
3538
:special-members:
36-
39+
3740
Objects.Tag
3841
-----------
3942

@@ -73,15 +76,15 @@ Objects.Submodule.root
7376
:members:
7477
:undoc-members:
7578
:special-members:
76-
79+
7780
Objects.Submodule.util
7881
----------------------
7982

8083
.. automodule:: git.objects.submodule.util
8184
:members:
8285
:undoc-members:
8386
:special-members:
84-
87+
8588
Objects.Util
8689
-------------
8790

@@ -105,23 +108,23 @@ Index.Functions
105108
:members:
106109
:undoc-members:
107110
:special-members:
108-
111+
109112
Index.Types
110113
-----------
111114

112115
.. automodule:: git.index.typ
113116
:members:
114117
:undoc-members:
115118
:special-members:
116-
119+
117120
Index.Util
118121
-------------
119122

120123
.. automodule:: git.index.util
121124
:members:
122125
:undoc-members:
123126
:special-members:
124-
127+
125128
GitCmd
126129
------
127130

@@ -137,7 +140,7 @@ Config
137140
:members:
138141
:undoc-members:
139142
:special-members:
140-
143+
141144
Diff
142145
----
143146

@@ -154,15 +157,15 @@ Exceptions
154157
:undoc-members:
155158
:special-members:
156159

157-
160+
158161
Refs.symbolic
159162
-------------
160163

161164
.. automodule:: git.refs.symbolic
162165
:members:
163166
:undoc-members:
164167
:special-members:
165-
168+
166169
Refs.reference
167170
--------------
168171

@@ -178,31 +181,31 @@ Refs.head
178181
:members:
179182
:undoc-members:
180183
:special-members:
181-
184+
182185
Refs.tag
183186
------------
184187

185188
.. automodule:: git.refs.tag
186189
:members:
187190
:undoc-members:
188191
:special-members:
189-
192+
190193
Refs.remote
191194
------------
192195

193196
.. automodule:: git.refs.remote
194197
:members:
195198
:undoc-members:
196199
:special-members:
197-
200+
198201
Refs.log
199202
------------
200203

201204
.. automodule:: git.refs.log
202205
:members:
203206
:undoc-members:
204207
:special-members:
205-
208+
206209
Remote
207210
------
208211

@@ -218,7 +221,7 @@ Repo.Base
218221
:members:
219222
:undoc-members:
220223
:special-members:
221-
224+
222225
Repo.Functions
223226
--------------
224227

0 commit comments

Comments
 (0)