Skip to content

Commit c3bd05b

Browse files
ByronByron
committed
Added doc-index, which helps to keep documentation of prior but still somewhat supported versions alive
1 parent d2ebc61 commit c3bd05b

46 files changed

Lines changed: 7578 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/doc_index/0.1/_sources/index.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. GitPython documentation master file, created by sphinx-quickstart on Sat Jan 24 11:51:01 2009.
2+
You can adapt this file completely to your liking, but it should at least
3+
contain the root `toctree` directive.
4+
5+
GitPython Documentation
6+
=======================
7+
8+
Contents:
9+
10+
.. toctree::
11+
:maxdepth: 3
12+
13+
intro
14+
tutorial
15+
reference
16+
17+
Indices and tables
18+
==================
19+
20+
* :ref:`genindex`
21+
* :ref:`modindex`
22+
* :ref:`search`
23+

‎doc/doc_index/0.1/_sources/intro.txt‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
.. _intro_toplevel:
2+
3+
==================
4+
Overview / Install
5+
==================
6+
7+
GitPython is a python library used to interact with Git repositories.
8+
9+
GitPython is a port of the grit_ library in Ruby created by
10+
Tom Preston-Werner and Chris Wanstrath.
11+
12+
.. _grit: http://grit.rubyforge.org
13+
14+
Requirements
15+
============
16+
17+
* Git_ tested with 1.5.3.7
18+
* `Python Nose`_ - used for running the tests
19+
* `Mock by Michael Foord`_ used for tests. Requires 0.5 or higher
20+
21+
.. _Git: http://git-scm.com/
22+
.. _Python Nose: http://code.google.com/p/python-nose/
23+
.. _Mock by Michael Foord: http://www.voidspace.org.uk/python/mock/
24+
25+
Installing GitPython
26+
====================
27+
28+
Installing GitPython is easily done using
29+
`setuptools`_. Assuming it is
30+
installed, just run the following from the command-line:
31+
32+
.. sourcecode:: none
33+
34+
# easy_install GitPython
35+
36+
This command will download the latest version of GitPython from the
37+
`Python Package Index <http://pypi.python.org/pypi/GitPython>`_ and install it
38+
to your system. More information about ``easy_install`` and pypi can be found
39+
here:
40+
41+
* `setuptools`_
42+
* `install setuptools <http://peak.telecommunity.com/DevCenter/EasyInstall#installation-instructions>`_
43+
* `pypi <http://pypi.python.org/pypi/GitPython>`_
44+
45+
.. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
46+
47+
Alternatively, you can install from the distribution using the ``setup.py``
48+
script:
49+
50+
.. sourcecode:: none
51+
52+
# python setup.py install
53+
54+
Getting Started
55+
===============
56+
57+
* :ref:`tutorial_toplevel` - This tutorial provides a walk-through of some of
58+
the basic functionality and concepts used in GitPython. It, however, is not
59+
exhaustive so you are encouraged to spend some time in the
60+
:ref:`api_reference_toplevel`.
61+
62+
API Reference
63+
=============
64+
65+
An organized section of the GitPthon API is at :ref:`api_reference_toplevel`.
66+
67+
Source Code
68+
===========
69+
70+
GitPython's git repo is available on Gitorious, which can be browsed at:
71+
72+
http://gitorious.org/git-python
73+
74+
and cloned from:
75+
76+
git://gitorious.org/git-python/mainline.git
77+
78+
License Information
79+
===================
80+
81+
GitPython is licensed under the New BSD License. See the LICENSE file for
82+
more information.
83+

‎doc/doc_index/0.1/_sources/reference.txt‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
.. _api_reference_toplevel:
2+
3+
API Reference
4+
=============
5+
6+
Actor
7+
-----
8+
9+
.. automodule:: git.actor
10+
:members:
11+
:undoc-members:
12+
13+
Blob
14+
----
15+
16+
.. automodule:: git.blob
17+
:members:
18+
:undoc-members:
19+
20+
Git
21+
---
22+
23+
.. automodule:: git.cmd
24+
:members:
25+
:undoc-members:
26+
27+
Commit
28+
------
29+
30+
.. automodule:: git.commit
31+
:members:
32+
:undoc-members:
33+
34+
Diff
35+
----
36+
37+
.. automodule:: git.diff
38+
:members:
39+
:undoc-members:
40+
41+
Errors
42+
------
43+
44+
.. automodule:: git.errors
45+
:members:
46+
:undoc-members:
47+
48+
Head
49+
----
50+
51+
.. automodule:: git.head
52+
:members:
53+
:undoc-members:
54+
55+
Lazy
56+
----
57+
58+
.. automodule:: git.lazy
59+
:members:
60+
:undoc-members:
61+
62+
Repo
63+
----
64+
65+
.. automodule:: git.repo
66+
:members:
67+
:undoc-members:
68+
69+
Stats
70+
-----
71+
72+
.. automodule:: git.stats
73+
:members:
74+
:undoc-members:
75+
76+
Tag
77+
---
78+
79+
.. automodule:: git.tag
80+
:members:
81+
:undoc-members:
82+
83+
Tree
84+
----
85+
86+
.. automodule:: git.tree
87+
:members:
88+
:undoc-members:
89+
90+
Utils
91+
-----
92+
93+
.. automodule:: git.utils
94+
:members:
95+
:undoc-members:

0 commit comments

Comments
 (0)