Overhauled all tutorials, and placed them in a unit-test.

That way they are protected from regression.

Fixes #239

Author: Byron

README.md

@@ -50,7 +50,7 @@ Then run:
 
 GitPython's git repo is available on GitHub, which can be browsed at [github](https://github.com/gitpython-developers/GitPython) and cloned like that:
 
-    git clone git://github.com/gitpython-developers/GitPython.git git-python
+    git clone https://github.com/gitpython-developers/GitPython
 
 ### Live Coding
 

doc/source/changes.rst

@@ -4,19 +4,22 @@ Changelog
 
 0.3.6 - Features
 ================
-* Added `Repo.merge_base()` implementation. See the `respective issue on github <https://github.com/gitpython-developers/GitPython/issues/169>`_
-* `[include]` sections in git configuration files are now respected
-* Added `GitConfigParser.rename_section()`
-* DOCS: special members like `__init__` are now listed in the API documentation
-* DOCS: tutorial section was revised entirely
-* Added `Submodule.rename()`
+* **DOCS**
+
+  * special members like `__init__` are now listed in the API documentation
+  * tutorial section was revised entirely, more advanced examples were added.
+
 * **POSSIBLY BREAKING CHANGES**
 
   * As `rev_parse` will now throw `BadName` as well as `BadObject`, client code will have to catch both exception types.
   * Repo.working_tree_dir now returns None if it is bare. Previously it raised AssertionError.
   * IndexFile.add() previously raised AssertionError when paths where used with bare repository, now it raises InvalidGitRepositoryError
-
-* A list of all issues can be found here: https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+
+  
+* Added `Repo.merge_base()` implementation. See the `respective issue on github <https://github.com/gitpython-developers/GitPython/issues/169>`_
+* `[include]` sections in git configuration files are now respected
+* Added `GitConfigParser.rename_section()`
+* Added `Submodule.rename()`
+* A list of all issues can be found `on github <https://github.com/gitpython-developers/GitPython/issues?q=milestone%3A%22v0.3.6+-+Features%22+>`_
 
 0.3.5 - Bugfixes
 ================

doc/source/reference.rst

@@ -33,105 +33,119 @@ Objects.Tag
 .. automodule:: git.objects.tag
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Tree
 ------------
 
 .. automodule:: git.objects.tree
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Functions
 -----------------
 
 .. automodule:: git.objects.fun
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Submodule.base
 ----------------------
 
 .. automodule:: git.objects.submodule.base
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Submodule.root
 ----------------------
 
 .. automodule:: git.objects.submodule.root
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Submodule.util
 ----------------------
 
 .. automodule:: git.objects.submodule.util
    :members:
    :undoc-members:
+   :special-members:
 
 Objects.Util
 -------------
 
 .. automodule:: git.objects.util
    :members:
    :undoc-members:
+   :special-members:
 
 Index.Base
 ----------
 
 .. automodule:: git.index.base
    :members:
    :undoc-members:
+   :special-members:
 
 Index.Functions
 ---------------
 
 .. automodule:: git.index.fun
    :members:
    :undoc-members:
+   :special-members:
 
 Index.Types
 -----------
 
 .. automodule:: git.index.typ
    :members:
    :undoc-members:
+   :special-members:
 
 Index.Util
 -------------
 
 .. automodule:: git.index.util
    :members:
    :undoc-members:
+   :special-members:
 
 GitCmd
 ------
 
 .. automodule:: git.cmd
    :members:
    :undoc-members:
-
+   :special-members:
 
 Config
 ------
 
 .. automodule:: git.config
    :members:
    :undoc-members:
+   :special-members:
 
 Diff
 ----
 
 .. automodule:: git.diff
    :members:
    :undoc-members:
+   :special-members:
 
 Exceptions
 ----------
 
 .. automodule:: git.exc
    :members:
    :undoc-members:
+   :special-members:
 
 
 Refs.symbolic
@@ -140,66 +154,76 @@ Refs.symbolic
 .. automodule:: git.refs.symbolic
    :members:
    :undoc-members:
+   :special-members:
 
 Refs.reference
 --------------
 
 .. automodule:: git.refs.reference
    :members:
    :undoc-members:
+   :special-members:
 
 Refs.head
 ---------
 
 .. automodule:: git.refs.head
    :members:
    :undoc-members:
+   :special-members:
 
 Refs.tag
 ------------
 
 .. automodule:: git.refs.tag
    :members:
    :undoc-members:
+   :special-members:
 
 Refs.remote
 ------------
 
 .. automodule:: git.refs.remote
    :members:
    :undoc-members:
+   :special-members:
 
 Refs.log
 ------------
 
 .. automodule:: git.refs.log
    :members:
    :undoc-members:
+   :special-members:
 
 Remote
 ------
 
 .. automodule:: git.remote
    :members:
    :undoc-members:
+   :special-members:
 
 Repo.Base
 ---------
 
 .. automodule:: git.repo.base
    :members:
    :undoc-members:
+   :special-members:
 
 Repo.Functions
 --------------
 
 .. automodule:: git.repo.fun
    :members:
    :undoc-members:
+   :special-members:
 
 Util
 ----
 
 .. automodule:: git.util
    :members:
    :undoc-members:
+   :special-members: