Update docs

Author: jdavid

docs/config.rst

@@ -2,41 +2,22 @@
 Configuration files
 **********************************************************************
 
-.. autoattribute:: pygit2.Repository.config
+.. autoclass:: pygit2.Repository
+   :members: config
+   :noindex:
 
 
 The Config type
 ================
 
-.. automethod:: pygit2.Config.get_system_config
-.. automethod:: pygit2.Config.get_global_config
-.. automethod:: pygit2.Config.add_file
-.. automethod:: pygit2.Config.get_multivar
-.. automethod:: pygit2.Config.set_multivar
-
-.. method:: Config.__iter__()
-
-   The :class:`Config` class has an iterator which can be used to loop
-   through all the entries in the configuration. Each element is a
-   ``ConfigEntry`` object containing the name, level, and value of each
-   configuration variable. Be aware that this may return multiple versions of
-   each entry if they are set multiple times in the configuration files.
-
-.. currentmodule:: pygit2
-
-The :class:`Config` Mapping interface.
-
-When using the mapping interface, the value is returned as a
-string. In order to apply the git-config parsing rules, you can use
-:meth:`Config.get_bool` or :meth:`Config.get_int`.
-
-.. automethod:: pygit2.Config.get_bool
-.. automethod:: pygit2.Config.get_int
+.. autoclass:: pygit2.Config
+   :members:
+   :undoc-members:
+   :special-members: __contains__, __delitem__, __getitem__, __iter__, __setitem__
 
 
 The ConfigEntry type
 ====================
 
-.. autoattribute:: pygit2.config.ConfigEntry.name
-.. autoattribute:: pygit2.config.ConfigEntry.value
-.. autoattribute:: pygit2.config.ConfigEntry.level
+.. autoclass:: pygit2.config.ConfigEntry
+   :members: name, value, level

docs/index.rst

@@ -82,6 +82,7 @@ Table of Contents
    merge
    objects
    oid
+   packing
    references
    remotes
    repository

docs/packing.rst

@@ -0,0 +1,16 @@
+**********************************************************************
+Packing
+**********************************************************************
+
+.. autoclass:: pygit2.Repository
+   :members: pack
+   :noindex:
+
+
+The PackBuilder
+================
+
+.. autoclass:: pygit2.PackBuilder
+   :members:
+   :undoc-members:
+   :special-members: __len__

docs/repository.rst

@@ -54,9 +54,9 @@ Below there are some general attributes and methods:
 
 .. autoclass:: pygit2.Repository
    :members: ahead_behind, applies, apply, create_reference, default_signature,
-             descendant_of, describe, free, is_bare, is_empty, odb, path,
-             path_is_ignored, reset, revert_commit, state_cleanup, workdir,
-             write, write_archive, set_odb, set_refdb
+             descendant_of, describe, free, is_bare, is_empty, is_shallow, odb,
+             path, path_is_ignored, reset, revert_commit, state_cleanup,
+             workdir, write, write_archive, set_odb, set_refdb
 
    The Repository constructor will most commonly be called with one argument, the path of the repository to open.
 

pygit2/config.py

@@ -126,6 +126,11 @@ def __contains__(self, key):
         return True
 
     def __getitem__(self, key):
+        """
+        When using the mapping interface, the value is returned as a string. In
+        order to apply the git-config parsing rules, you can use
+        :meth:`Config.get_bool` or :meth:`Config.get_int`.
+        """
         entry = self._get_entry(key)
 
         return entry.value
@@ -151,6 +156,12 @@ def __delitem__(self, key):
         check_error(err)
 
     def __iter__(self):
+        """
+        Iterate over configuration entries, returning a ``ConfigEntry``
+        objects. These contain the name, level, and value of each configuration
+        variable. Be aware that this may return multiple versions of each entry
+        if they are set multiple times in the configuration files.
+        """
         citer = ffi.new('git_config_iterator **')
         err = C.git_config_iterator_new(citer, self._config)
         check_error(err)

pygit2/packbuilder.py

@@ -53,18 +53,18 @@ def __len__(self):
         return C.git_packbuilder_object_count(self._packbuilder)
 
     @staticmethod
-    def convert_object_to_oid(oid):
+    def __convert_object_to_oid(oid):
         git_oid = ffi.new('git_oid *')
         ffi.buffer(git_oid)[:] = oid.raw[:]
         return git_oid
 
     def add(self, oid):
-        git_oid = self.convert_object_to_oid(oid)
+        git_oid = self.__convert_object_to_oid(oid)
         err = C.git_packbuilder_insert(self._packbuilder, git_oid, ffi.NULL)
         check_error(err)
 
     def add_recur(self, oid):
-        git_oid = self.convert_object_to_oid(oid)
+        git_oid = self.__convert_object_to_oid(oid)
         err = C.git_packbuilder_insert_recur(self._packbuilder, git_oid, ffi.NULL)
         check_error(err)
 

pygit2/repository.py

@@ -265,11 +265,11 @@ def create_reference(self, name, target, force=False, message=None):
 
         Keyword arguments:
 
-        force : bool
+        force: bool
             If True references will be overridden, otherwise (the default) an
             exception is raised.
 
-        message : str
+        message: str
             Optional message to use for the reflog.
 
         Examples::