From 160081b9a7ca191afbec077c4bf970cfd9070d2c Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 29 Jun 2010 18:28:31 +0200 Subject: Updated and fixed sphinx API docs, which included one quick skim-through --- doc/reference.rst | 63 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 42 insertions(+), 21 deletions(-) (limited to 'doc/reference.rst') diff --git a/doc/reference.rst b/doc/reference.rst index 9cc32b71..90df10f8 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -3,13 +3,6 @@ API Reference ============= -Actor ------ - -.. automodule:: git.actor - :members: - :undoc-members: - Objects.Base ------------ @@ -45,12 +38,54 @@ Objects.Tree :members: :undoc-members: +Objects.Functions +----------------- + +.. automodule:: git.objects.fun + :members: + :undoc-members: + +Objects.Submodule +----------------- + +.. automodule:: git.objects.submodule + :members: + :undoc-members: + Objects.Utils ------------- .. automodule:: git.objects.utils :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 ------ @@ -81,13 +116,6 @@ Errors :members: :undoc-members: -Index ------- - -.. automodule:: git.index - :members: - :undoc-members: - Refs ---- @@ -110,13 +138,6 @@ Repo :members: :undoc-members: -Stats ------ - -.. automodule:: git.stats - :members: - :undoc-members: - Utils ----- -- cgit v1.2.3 From 0369384c8b79c44c5369f1b6c05046899f8886da Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Tue, 29 Jun 2010 21:49:31 +0200 Subject: revised tutorial to match the changed usage, added basic information about object databases --- doc/reference.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/reference.rst') diff --git a/doc/reference.rst b/doc/reference.rst index 90df10f8..5952fe2d 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -52,15 +52,15 @@ Objects.Submodule :members: :undoc-members: -Objects.Utils +Objects.Util ------------- -.. automodule:: git.objects.utils +.. automodule:: git.objects.util :members: :undoc-members: Index.Base -------------- +---------- .. automodule:: git.index.base :members: @@ -138,9 +138,9 @@ Repo :members: :undoc-members: -Utils ------ +Util +---- -.. automodule:: git.utils +.. automodule:: git.util :members: :undoc-members: -- cgit v1.2.3 From d2ebc6193f7205fd1686678a5707262cb1c59bb0 Mon Sep 17 00:00:00 2001 From: Sebastian Thiel Date: Thu, 1 Jul 2010 16:11:43 +0200 Subject: Moved all source files into the source folder, separating the build from the source directory --- doc/reference.rst | 146 ------------------------------------------------------ 1 file changed, 146 deletions(-) delete mode 100644 doc/reference.rst (limited to 'doc/reference.rst') diff --git a/doc/reference.rst b/doc/reference.rst deleted file mode 100644 index 5952fe2d..00000000 --- a/doc/reference.rst +++ /dev/null @@ -1,146 +0,0 @@ -.. _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 ------------------ - -.. automodule:: git.objects.submodule - :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: - -Errors ------- - -.. automodule:: git.errors - :members: - :undoc-members: - - -Refs ----- - -.. automodule:: git.refs - :members: - :undoc-members: - -Remote ------- - -.. automodule:: git.remote - :members: - :undoc-members: - -Repo ----- - -.. automodule:: git.repo - :members: - :undoc-members: - -Util ----- - -.. automodule:: git.util - :members: - :undoc-members: -- cgit v1.2.3