Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 9ccd777

Browse filesBrowse files
ByronByron
committed
Documentation is now being built for all new modules
1 parent 8ad01ee commit 9ccd777
Copy full SHA for 9ccd777

File tree

8 files changed

+56
-12
lines changed
Filter options

8 files changed

+56
-12
lines changed

‎doc/source/changes.rst

Copy file name to clipboardExpand all lines: doc/source/changes.rst
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Changelog
33
=========
44

5+
0.3.2 Beta 2
6+
============
7+
* Added reflog support ( reading and writing )
8+
59
0.3.2 Beta 1
610
============
711
* Flattened directory structure to make development more convenient.

‎doc/source/conf.py

Copy file name to clipboardExpand all lines: doc/source/conf.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# is relative to the documentation root, use os.path.abspath to make it
2121
# absolute, like shown here.
2222
#sys.path.append(os.path.abspath('.'))
23-
sys.path.insert(0, os.path.abspath('../../lib'))
23+
sys.path.insert(0, os.path.abspath('../../../'))
2424

2525
# General configuration
2626
# ---------------------

‎doc/source/reference.rst

Copy file name to clipboardExpand all lines: doc/source/reference.rst
+38-3Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,13 +131,48 @@ Exceptions
131131
:undoc-members:
132132

133133

134-
Refs
135-
----
134+
Refs.symbolic
135+
-------------
136+
137+
.. automodule:: git.refs.symbolic
138+
:members:
139+
:undoc-members:
140+
141+
Refs.reference
142+
--------------
136143

137-
.. automodule:: git.refs
144+
.. automodule:: git.refs.reference
138145
:members:
139146
:undoc-members:
140147

148+
Refs.head
149+
---------
150+
151+
.. automodule:: git.refs.head
152+
:members:
153+
:undoc-members:
154+
155+
Refs.tag
156+
------------
157+
158+
.. automodule:: git.refs.tag
159+
:members:
160+
:undoc-members:
161+
162+
Refs.remote
163+
------------
164+
165+
.. automodule:: git.refs.remote
166+
:members:
167+
:undoc-members:
168+
169+
Refs.log
170+
------------
171+
172+
.. automodule:: git.refs.log
173+
:members:
174+
:undoc-members:
175+
141176
Remote
142177
------
143178

‎doc/source/tutorial.rst

Copy file name to clipboardExpand all lines: doc/source/tutorial.rst
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,14 @@ A symbolic reference is a special case of a reference as it points to another re
8888
head = repo.head # the head points to the active branch/ref
8989
master = head.reference # retrieve the reference the head points to
9090
master.commit # from here you use it as any other reference
91+
92+
Access the reflog easily::
93+
94+
log = master.log()
95+
log[0] # first (i.e. oldest) reflog entry
96+
log[-1] # last (i.e. most recent) reflog entry
97+
98+
For more information on the reflog, see the ``RefLog`` type's documentation.
9199

92100
Modifying References
93101
********************

‎index/base.py

Copy file name to clipboardExpand all lines: index/base.py
-2Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
#
44
# This module is part of GitPython and is released under
55
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
6-
"""Module containing Index implementation, allowing to perform all kinds of index
7-
manipulations such as querying and merging."""
86
import tempfile
97
import os
108
import sys

‎index/fun.py

Copy file name to clipboardExpand all lines: index/fun.py
+3-4Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
"""
2-
Contains standalone functions to accompany the index implementation and make it
3-
more versatile
4-
"""
1+
# Contains standalone functions to accompany the index implementation and make it
2+
# more versatile
3+
# NOTE: Autodoc hates it if this is a docstring
54
from stat import (
65
S_IFDIR,
76
S_IFLNK,

‎refs/head.py

Copy file name to clipboardExpand all lines: refs/head.py
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" Module containing all ref based objects """
21
from symbolic import SymbolicReference
32
from reference import Reference
43

‎remote.py

Copy file name to clipboardExpand all lines: remote.py
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
#
44
# This module is part of GitPython and is released under
55
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
6-
"""Module implementing a remote object allowing easy access to git remotes"""
6+
7+
# Module implementing a remote object allowing easy access to git remotes
78

89
from exc import GitCommandError
910
from objects import Commit

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.