diff --git a/_sources/index.txt b/_sources/index.txt index 354736e..a433f57 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -10,7 +10,7 @@ Contents: .. toctree:: :maxdepth: 2 - + pygit2 diff --git a/_sources/pygit2.txt b/_sources/pygit2.txt index 04318c6..8a6d303 100644 --- a/_sources/pygit2.txt +++ b/_sources/pygit2.txt @@ -3,3 +3,4 @@ .. automodule:: pygit2 :members: + :show-inheritance: diff --git a/doctrees/environment.pickle b/doctrees/environment.pickle index d4abcdc..280758d 100644 Binary files a/doctrees/environment.pickle and b/doctrees/environment.pickle differ diff --git a/doctrees/pygit2.doctree b/doctrees/pygit2.doctree index cc1396d..8f353b8 100644 Binary files a/doctrees/pygit2.doctree and b/doctrees/pygit2.doctree differ diff --git a/genindex.html b/genindex.html index 2561834..72bce28 100644 --- a/genindex.html +++ b/genindex.html @@ -126,6 +126,10 @@
+
create_blob() (pygit2.Repository method) +
+ +
create_commit() (pygit2.Repository method)
@@ -151,10 +155,14 @@
data (pygit2.Blob attribute)
+ +
delete() (pygit2.Reference method) +
+
-
delete() (pygit2.Reference method) +
discover_repository() (in module pygit2)
@@ -401,10 +409,14 @@
Signature (class in pygit2)
+ +
status() (pygit2.Repository method) +
+
-
status() (pygit2.Repository method) +
status_file() (pygit2.Repository method)
@@ -450,6 +462,10 @@ +
TreeBuilder() (pygit2.Repository method) +
+ +
TreeEntry (class in pygit2)
diff --git a/objects.inv b/objects.inv index ccb2aed..d9f2003 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/pygit2.html b/pygit2.html index 0a32eaa..ad5866c 100644 --- a/pygit2.html +++ b/pygit2.html @@ -56,7 +56,8 @@
class pygit2.Blob
-

Blob objects

+

Bases: pygit2.Object

+

Blob objects

data
@@ -68,7 +69,8 @@
class pygit2.Commit
-

Commit objects

+

Bases: pygit2.Object

+

Commit objects

author
@@ -122,7 +124,8 @@
class pygit2.Index
-

Index file

+

Bases: object

+

Index file

add()
@@ -164,7 +167,8 @@
class pygit2.IndexEntry
-

Index entry

+

Bases: object

+

Index entry

hex
@@ -194,7 +198,8 @@
class pygit2.Object
-

Object objects

+

Bases: object

+

Object objects

hex
@@ -224,7 +229,8 @@
class pygit2.Reference
-

Reference

+

Bases: object

+

Reference

delete()
@@ -284,7 +290,20 @@
class pygit2.Repository
-

Git repository

+

Bases: object

+

Git repository

+
+
+TreeBuilder()
+

Create a TreeBuilder object for this repository.

+
+ +
+
+create_blob()
+

Create a new blob from memory

+
+
create_commit()
@@ -349,10 +368,16 @@
status()
-

Reads the status of the repository and returns a dictionnary with file paths as keys and status flags as values. +

Reads the status of the repository and returns a dictionary with file paths as keys and status flags as values. See pygit2.GIT_STATUS_*.

+
+
+status_file()
+

Returns the status of the given file path.

+
+
walk()
@@ -378,7 +403,8 @@ of the created object.

class pygit2.Signature
-

Signature

+

Bases: object

+

Signature

email
@@ -408,7 +434,8 @@ of the created object.

class pygit2.Tag
-

Tag objects

+

Bases: pygit2.Object

+

Tag objects

message
@@ -438,13 +465,15 @@ of the created object.

class pygit2.Tree
-

Tree objects

+

Bases: pygit2.Object

+

Tree objects

class pygit2.TreeEntry
-

TreeEntry objects

+

Bases: object

+

TreeEntry objects

attributes
@@ -477,6 +506,12 @@ of the created object.

+
+
+pygit2.discover_repository()
+

Look for a git repository and return its path.

+
+
pygit2.init_repository()
diff --git a/searchindex.js b/searchindex.js index 8ccd193..666941e 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({objects:{"":{pygit2:[1,0,1,""]},"pygit2.Tag":{message:[1,1,1,""],tagger:[1,1,1,""],name:[1,1,1,""],target:[1,1,1,""]},"pygit2.TreeEntry":{attributes:[1,1,1,""],to_object:[1,2,1,""],oid:[1,1,1,""],hex:[1,1,1,""],name:[1,1,1,""]},"pygit2.Index":{write_tree:[1,2,1,""],read:[1,2,1,""],clear:[1,2,1,""],write:[1,2,1,""],add:[1,2,1,""],read_tree:[1,2,1,""]},"pygit2.Repository":{status:[1,2,1,""],index:[1,1,1,""],listall_references:[1,2,1,""],workdir:[1,1,1,""],create_commit:[1,2,1,""],create_tag:[1,2,1,""],read:[1,2,1,""],create_reference:[1,2,1,""],walk:[1,2,1,""],lookup_reference:[1,2,1,""],write:[1,2,1,""],path:[1,1,1,""],packall_references:[1,2,1,""],create_symbolic_reference:[1,2,1,""]},"pygit2.Blob":{data:[1,1,1,""]},"pygit2.Commit":{committer:[1,1,1,""],commit_time_offset:[1,1,1,""],author:[1,1,1,""],message_encoding:[1,1,1,""],tree:[1,1,1,""],parents:[1,1,1,""],message:[1,1,1,""],commit_time:[1,1,1,""]},"pygit2.Reference":{rename:[1,2,1,""],resolve:[1,2,1,""],name:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],reload:[1,2,1,""],target:[1,1,1,""],type:[1,1,1,""],"delete":[1,2,1,""]},"pygit2.Signature":{offset:[1,1,1,""],email:[1,1,1,""],name:[1,1,1,""],time:[1,1,1,""]},"pygit2.Object":{type:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],read_raw:[1,2,1,""]},pygit2:{Index:[1,3,1,""],Repository:[1,3,1,""],Reference:[1,3,1,""],IndexEntry:[1,3,1,""],Object:[1,3,1,""],Tree:[1,3,1,""],Tag:[1,3,1,""],Blob:[1,3,1,""],init_repository:[1,4,1,""],Signature:[1,3,1,""],Commit:[1,3,1,""],TreeEntry:[1,3,1,""]},"pygit2.IndexEntry":{path:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],mode:[1,1,1,""]}},terms:{libgit2:1,all:1,tagger:1,read_tre:1,disk:1,read_raw:1,add:1,blob:1,indexentri:1,git_status_:1,"return":1,python:1,repo:1,liter:1,look:1,name:1,write_tre:1,docutil:1,list:1,resolv:1,reload:1,listall_refer:1,mode:1,commit_tim:1,refer:1,page:0,hard:1,back:1,see:1,commit_time_offset:1,bare:1,read:1,create_refer:1,index:[0,1],statu:1,kei:1,sha:1,message_encod:1,content:[0,1],delet:1,"new":1,email:1,attribut:1,signatur:1,full:1,parent:1,gener:1,given:1,committ:1,git_ref_symbol:1,git_ref_oid:1,repositori:1,offset:1,span:1,valu:1,search:0,base:[],commit:1,first:1,point:1,modul:0,encod:1,number:1,walk:1,path:1,git_ref_pack:1,git:1,from:1,creat:1,memori:1,hex:1,system:1,messag:1,start:1,type:1,direct:1,flag:1,atom:1,packall_refer:1,folder:1,create_symbolic_refer:1,none:1,target:1,work:1,tree:1,second:1,histori:1,entri:1,to_object:1,loos:1,pack:1,pre:1,init_repositori:1,create_tag:1,lock:1,arg:1,indic:0,treeentri:1,raw:1,tag:1,exist:1,file:1,tabl:0,welcom:0,author:1,titl:[],write:1,dictionnari:1,valid:1,lookup:1,document:0,pygit2:[0,1],updat:1,workdir:1,create_commit:1,normal:1,buffer:1,symbol:1,oid:1,lookup_refer:1,data:1,"class":1,travers:1,renam:1,longer:1,directori:1,bind:1,clear:1,correspond:1,object:1,thi:1,time:1},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class","4":"py:function"},titles:["Welcome to pygit2’s documentation!","pygit2"],objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"]},filenames:["index","pygit2"]}) \ No newline at end of file +Search.setIndex({objects:{"":{pygit2:[1,0,1,""]},"pygit2.Tag":{message:[1,1,1,""],tagger:[1,1,1,""],name:[1,1,1,""],target:[1,1,1,""]},"pygit2.TreeEntry":{attributes:[1,1,1,""],to_object:[1,2,1,""],oid:[1,1,1,""],hex:[1,1,1,""],name:[1,1,1,""]},"pygit2.Index":{write_tree:[1,2,1,""],read:[1,2,1,""],clear:[1,2,1,""],write:[1,2,1,""],add:[1,2,1,""],read_tree:[1,2,1,""]},"pygit2.Repository":{status:[1,2,1,""],index:[1,1,1,""],listall_references:[1,2,1,""],workdir:[1,1,1,""],create_commit:[1,2,1,""],create_tag:[1,2,1,""],read:[1,2,1,""],create_reference:[1,2,1,""],TreeBuilder:[1,2,1,""],walk:[1,2,1,""],lookup_reference:[1,2,1,""],write:[1,2,1,""],path:[1,1,1,""],status_file:[1,2,1,""],create_blob:[1,2,1,""],packall_references:[1,2,1,""],create_symbolic_reference:[1,2,1,""]},"pygit2.Blob":{data:[1,1,1,""]},"pygit2.Commit":{committer:[1,1,1,""],commit_time_offset:[1,1,1,""],author:[1,1,1,""],message_encoding:[1,1,1,""],tree:[1,1,1,""],parents:[1,1,1,""],message:[1,1,1,""],commit_time:[1,1,1,""]},"pygit2.Reference":{rename:[1,2,1,""],resolve:[1,2,1,""],name:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],reload:[1,2,1,""],target:[1,1,1,""],type:[1,1,1,""],"delete":[1,2,1,""]},"pygit2.Signature":{email:[1,1,1,""],offset:[1,1,1,""],name:[1,1,1,""],time:[1,1,1,""]},"pygit2.Object":{type:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],read_raw:[1,2,1,""]},pygit2:{Index:[1,3,1,""],Repository:[1,3,1,""],Reference:[1,3,1,""],IndexEntry:[1,3,1,""],Object:[1,3,1,""],Tree:[1,3,1,""],discover_repository:[1,4,1,""],Tag:[1,3,1,""],Blob:[1,3,1,""],init_repository:[1,4,1,""],Signature:[1,3,1,""],Commit:[1,3,1,""],TreeEntry:[1,3,1,""]},"pygit2.IndexEntry":{path:[1,1,1,""],oid:[1,1,1,""],hex:[1,1,1,""],mode:[1,1,1,""]}},terms:{libgit2:1,all:1,tagger:1,read_tre:1,disk:1,point:1,add:1,blob:1,indexentri:1,git_status_:1,"return":1,read:1,repo:1,look:1,name:1,write_tre:1,docutil:1,list:1,resolv:1,sha:1,listall_refer:1,mode:1,commit_tim:1,attribut:1,page:0,hard:1,back:1,see:1,workdir:1,bare:1,create_refer:1,index:[0,1],statu:1,kei:1,reload:1,message_encod:1,content:[0,1],delet:1,"new":1,email:1,refer:1,signatur:1,full:1,parent:1,gener:1,given:1,committ:1,git_ref_symbol:1,git_ref_oid:1,dictionari:1,offset:1,span:1,valu:1,search:0,base:1,commit:1,first:1,repositori:1,read_raw:1,modul:0,encod:1,number:1,walk:1,path:1,status_fil:1,git_ref_pack:1,git:1,from:1,init_repositori:1,memori:1,hex:1,system:1,messag:1,start:1,time:1,type:1,python:1,direct:1,flag:1,atom:1,packall_refer:1,folder:1,none:1,target:1,work:1,tree:1,second:1,histori:1,tag:1,bind:1,create_blob:1,to_object:1,loos:1,pack:1,pre:1,creat:1,create_tag:1,lock:1,arg:1,indic:0,correspond:1,raw:1,liter:1,exist:1,file:1,tabl:0,welcom:0,author:1,titl:[],write:1,dictionnari:[],valid:1,lookup:1,document:0,pygit2:[0,1],updat:1,treebuild:1,commit_time_offset:1,create_commit:1,normal:1,buffer:1,symbol:1,oid:1,lookup_refer:1,data:1,"class":1,discover_repositori:1,travers:1,renam:1,longer:1,directori:1,entri:1,clear:1,treeentri:1,object:1,thi:1,create_symbolic_refer:1},objtypes:{"0":"py:module","1":"py:attribute","2":"py:method","3":"py:class","4":"py:function"},titles:["Welcome to pygit2’s documentation!","pygit2"],objnames:{"0":["py","module","Python module"],"1":["py","attribute","Python attribute"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"]},filenames:["index","pygit2"]}) \ No newline at end of file