Added auto-doc api reference and fixed plenty of docstrings

6 files changed, 127 insertions, 1 deletions

diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..567609b
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1 @@
+build/
diff --git a/doc/source/api.rst b/doc/source/api.rst
new file mode 100644
index 0000000..417671d
--- /dev/null
+++ b/doc/source/api.rst
@@ -0,0 +1,113 @@
+.. _api_reference_toplevel:
+
+#############
+API Reference
+#############
+
+****************
+Database.Base
+****************
+
+.. automodule:: gitdb.db.base
+   :members:
+   :undoc-members:
+
+****************
+Database.Git
+****************
+
+.. automodule:: gitdb.db.git
+   :members:
+   :undoc-members:
+   
+****************
+Database.Loose
+****************
+
+.. automodule:: gitdb.db.loose
+   :members:
+   :undoc-members:
+   
+****************
+Database.Memory
+****************
+
+.. automodule:: gitdb.db.mem
+   :members:
+   :undoc-members:
+   
+****************
+Database.Pack
+****************
+
+.. automodule:: gitdb.db.pack
+   :members:
+   :undoc-members:
+   
+******************
+Database.Reference
+******************
+
+.. automodule:: gitdb.db.ref
+   :members:
+   :undoc-members:
+   
+************
+Base
+************
+
+.. automodule:: gitdb.base
+   :members:
+   :undoc-members:  
+
+************
+Functions
+************
+
+.. automodule:: gitdb.fun
+   :members:
+   :undoc-members:  
+
+************
+Pack
+************
+
+.. automodule:: gitdb.pack
+   :members:
+   :undoc-members:  
+   
+************
+Streams
+************
+
+.. automodule:: gitdb.stream
+   :members:
+   :undoc-members:  
+
+************
+Types
+************
+
+.. automodule:: gitdb.typ
+   :members:
+   :undoc-members:  
+
+   
+************
+Utilities
+************
+
+.. automodule:: gitdb.util
+   :members:
+   :undoc-members:  
+
+   
+
+   
+
+
+
+   
+
+   
+
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 58b8791..d8aadab 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -16,7 +16,7 @@ import sys, os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory 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.append(os.path.abspath('../../../'))
 
 # -- General configuration -----------------------------------------------------
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 71ead1f..409c78e 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,6 +10,10 @@ Contents:
 
 .. toctree::
    :maxdepth: 2
+   
+   intro
+   tutorial
+   api
 
 Indices and tables
 ==================
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
new file mode 100644
index 0000000..9565e76
--- /dev/null
+++ b/doc/source/intro.rst
@@ -0,0 +1,4 @@
+########
+Overview
+########
+
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst
new file mode 100644
index 0000000..b23a177
--- /dev/null
+++ b/doc/source/tutorial.rst
@@ -0,0 +1,4 @@
+
+########
+Tutorial
+########