Skip to content

Commit

Permalink
Documentation is now being built for all new modules
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Nov 23, 2010
1 parent 8ad01ee commit 9ccd777
Show file tree
Hide file tree
Showing 8 changed files with 56 additions and 12 deletions.
4 changes: 4 additions & 0 deletions doc/source/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
Changelog
=========

0.3.2 Beta 2
============
* Added reflog support ( reading and writing )

0.3.2 Beta 1
============
* Flattened directory structure to make development more convenient.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../lib'))
sys.path.insert(0, os.path.abspath('../../../'))

# General configuration
# ---------------------
Expand Down
41 changes: 38 additions & 3 deletions doc/source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,48 @@ Exceptions
:undoc-members:


Refs
----
Refs.symbolic
-------------

.. automodule:: git.refs.symbolic
:members:
:undoc-members:

Refs.reference
--------------

.. automodule:: git.refs
.. automodule:: git.refs.reference
:members:
:undoc-members:

Refs.head
---------

.. automodule:: git.refs.head
:members:
:undoc-members:

Refs.tag
------------

.. automodule:: git.refs.tag
:members:
:undoc-members:

Refs.remote
------------

.. automodule:: git.refs.remote
:members:
:undoc-members:

Refs.log
------------

.. automodule:: git.refs.log
:members:
:undoc-members:

Remote
------

Expand Down
8 changes: 8 additions & 0 deletions doc/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,14 @@ A symbolic reference is a special case of a reference as it points to another re
head = repo.head # the head points to the active branch/ref
master = head.reference # retrieve the reference the head points to
master.commit # from here you use it as any other reference
Access the reflog easily::
log = master.log()
log[0] # first (i.e. oldest) reflog entry
log[-1] # last (i.e. most recent) reflog entry
For more information on the reflog, see the ``RefLog`` type's documentation.

Modifying References
********************
Expand Down
2 changes: 0 additions & 2 deletions index/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
"""Module containing Index implementation, allowing to perform all kinds of index
manipulations such as querying and merging."""
import tempfile
import os
import sys
Expand Down
7 changes: 3 additions & 4 deletions index/fun.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"""
Contains standalone functions to accompany the index implementation and make it
more versatile
"""
# Contains standalone functions to accompany the index implementation and make it
# more versatile
# NOTE: Autodoc hates it if this is a docstring
from stat import (
S_IFDIR,
S_IFLNK,
Expand Down
1 change: 0 additions & 1 deletion refs/head.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
""" Module containing all ref based objects """
from symbolic import SymbolicReference
from reference import Reference

Expand Down
3 changes: 2 additions & 1 deletion remote.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
#
# This module is part of GitPython and is released under
# the BSD License: http://www.opensource.org/licenses/bsd-license.php
"""Module implementing a remote object allowing easy access to git remotes"""

# Module implementing a remote object allowing easy access to git remotes

from exc import GitCommandError
from objects import Commit
Expand Down

0 comments on commit 9ccd777

Please sign in to comment.