Skip to content

Commit

Permalink
Added downloadable versions of the respective documentation, which sh…
Browse files Browse the repository at this point in the history
…ould aid packagers a bit
  • Loading branch information
Byron committed Apr 2, 2011
1 parent 96c7ac2 commit a98e0af
Show file tree
Hide file tree
Showing 34 changed files with 11,058 additions and 5 deletions.
Binary file added doc/doc_index/0.1/docs_0.1.zip
Binary file not shown.
Binary file added doc/doc_index/0.2/docs_0.2.zip
Binary file not shown.
Binary file added doc/doc_index/0.3.0/docs_0.3.0.zip
Binary file not shown.
413 changes: 413 additions & 0 deletions doc/doc_index/0.3.1/_sources/changes.txt

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions doc/doc_index/0.3.1/_sources/index.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. GitPython documentation master file, created by sphinx-quickstart on Sat Jan 24 11:51:01 2009.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

GitPython Documentation
=======================

.. toctree::
:maxdepth: 2

intro
whatsnew
tutorial
reference
roadmap
changes

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

112 changes: 112 additions & 0 deletions doc/doc_index/0.3.1/_sources/intro.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
.. _intro_toplevel:

==================
Overview / Install
==================

GitPython is a python library used to interact with git repositories, high-level like git-porcelain, or low-level like git-plumbing.

It provides abstractions of git objects for easy access of repository data, and additionally allows you to access the git repository more directly using either a pure python implementation, or the faster, but more resource intensive git command implementation.

The object database implementation is optimized for handling large quantities of objects and large datasets, which is achieved by using low-level structures and data streaming.

Requirements
============

* `Git`_ 1.7.0 or newer
It should also work with older versions, but it may be that some operations
involving remotes will not work as expected.
* `GitDB`_ - a pure python git database implementation

* `async`_ - asynchronous task scheduling

* `Python Nose`_ - used for running the tests
* `Mock by Michael Foord`_ used for tests. Requires version 0.5

.. _Git: http://git-scm.com/
.. _Python Nose: http://code.google.com/p/python-nose/
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock.html
.. _GitDB: http://pypi.python.org/pypi/gitdb
.. _async: http://pypi.python.org/pypi/async

Installing GitPython
====================

Installing GitPython is easily done using
`setuptools`_. Assuming it is
installed, just run the following from the command-line:

.. sourcecode:: none

# easy_install GitPython

This command will download the latest version of GitPython from the
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
to your system. More information about ``easy_install`` and pypi can be found
here:

* `setuptools`_
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
* `pypi <http://pypi.python.org/pypi/SQLAlchemy>`_

.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools

Alternatively, you can install from the distribution using the ``setup.py``
script:

.. sourcecode:: none

# python setup.py install

.. note:: In this case, you have to manually install `GitDB`_ and `async`_ as well. It would be recommended to use the :ref:`git source repository <source-code-label>` in that case.

Getting Started
===============

* :ref:`tutorial-label` - This tutorial provides a walk-through of some of
the basic functionality and concepts used in GitPython. It, however, is not
exhaustive so you are encouraged to spend some time in the
:ref:`api_reference_toplevel`.

API Reference
=============

An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.

.. _source-code-label:

Source Code
===========

GitPython's git repo is available on GitHub, which can be browsed at:

* https://github.com/gitpython-developers/GitPython

and cloned using::

$ git clone git://github.com/gitpython-developers/GitPython.git git-python

Initialize all submodules to obtain the required dependencies with::

$ cd git-python
$ git submodule update --init --recursive

Finally verify the installation by running the `nose powered <http://code.google.com/p/python-nose/>`_ unit tests::

$ nosetests

Mailing List
============
http://groups.google.com/group/git-python

Issue Tracker
=============
The issue tracker is hosted by github:

https://github.com/gitpython-developers/GitPython/issues

License Information
===================
GitPython is licensed under the New BSD License. See the LICENSE file for
more information.

202 changes: 202 additions & 0 deletions doc/doc_index/0.3.1/_sources/reference.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
.. _api_reference_toplevel:

API Reference
=============

Objects.Base
------------

.. automodule:: git.objects.base
:members:
:undoc-members:

Objects.Blob
------------

.. automodule:: git.objects.blob
:members:
:undoc-members:

Objects.Commit
--------------

.. automodule:: git.objects.commit
:members:
:undoc-members:

Objects.Tag
-----------

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

Objects.Tree
------------

.. automodule:: git.objects.tree
:members:
:undoc-members:

Objects.Functions
-----------------

.. automodule:: git.objects.fun
:members:
:undoc-members:

Objects.Submodule.base
----------------------

.. automodule:: git.objects.submodule.base
:members:
:undoc-members:

Objects.Submodule.root
----------------------

.. automodule:: git.objects.submodule.root
:members:
:undoc-members:

Objects.Submodule.util
----------------------

.. automodule:: git.objects.submodule.util
:members:
:undoc-members:

Objects.Util
-------------

.. automodule:: git.objects.util
:members:
:undoc-members:

Index.Base
----------

.. automodule:: git.index.base
:members:
:undoc-members:

Index.Functions
---------------

.. automodule:: git.index.fun
:members:
:undoc-members:

Index.Types
-----------

.. automodule:: git.index.typ
:members:
:undoc-members:

Index.Util
-------------

.. automodule:: git.index.util
:members:
:undoc-members:

GitCmd
------

.. automodule:: git.cmd
:members:
:undoc-members:


Config
------

.. automodule:: git.config
:members:
:undoc-members:

Diff
----

.. automodule:: git.diff
:members:
:undoc-members:

Exceptions
----------

.. automodule:: git.exc
:members:
:undoc-members:


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

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

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

.. 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
------

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

Repo.Base
---------

.. automodule:: git.repo.base
:members:
:undoc-members:

Repo.Functions
--------------

.. automodule:: git.repo.fun
:members:
:undoc-members:

Util
----

.. automodule:: git.util
:members:
:undoc-members:
9 changes: 9 additions & 0 deletions doc/doc_index/0.3.1/_sources/roadmap.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

#######
Roadmap
#######
The full list of milestones including associated tasks can be found on github:
https://github.com/gitpython-developers/GitPython/issues

Select the respective milestone to filter the list of issues accordingly.

Loading

0 comments on commit a98e0af

Please sign in to comment.