Update auto-generated docs to v0.17.0

_sources/index.txt

@@ -10,7 +10,7 @@ Contents:
 
 .. toctree::
    :maxdepth: 2
-   
+
    pygit2
 
 

_sources/pygit2.txt

@@ -3,3 +3,4 @@
 
 .. automodule:: pygit2
    :members:
+   :show-inheritance:

genindex.html

@@ -126,6 +126,10 @@
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
       
+  <dt><a href="pygit2.html#pygit2.Repository.create_blob">create_blob() (pygit2.Repository method)</a>
+  </dt>
+
+      
   <dt><a href="pygit2.html#pygit2.Repository.create_commit">create_commit() (pygit2.Repository method)</a>
   </dt>
 
@@ -151,10 +155,14 @@
   <dt><a href="pygit2.html#pygit2.Blob.data">data (pygit2.Blob attribute)</a>
   </dt>
 
+      
+  <dt><a href="pygit2.html#pygit2.Reference.delete">delete() (pygit2.Reference method)</a>
+  </dt>
+
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
       
-  <dt><a href="pygit2.html#pygit2.Reference.delete">delete() (pygit2.Reference method)</a>
+  <dt><a href="pygit2.html#pygit2.discover_repository">discover_repository() (in module pygit2)</a>
   </dt>
 
   </dl></td>
@@ -401,10 +409,14 @@
   <dt><a href="pygit2.html#pygit2.Signature">Signature (class in pygit2)</a>
   </dt>
 
+      
+  <dt><a href="pygit2.html#pygit2.Repository.status">status() (pygit2.Repository method)</a>
+  </dt>
+
   </dl></td>
   <td style="width: 33%" valign="top"><dl>
       
-  <dt><a href="pygit2.html#pygit2.Repository.status">status() (pygit2.Repository method)</a>
+  <dt><a href="pygit2.html#pygit2.Repository.status_file">status_file() (pygit2.Repository method)</a>
   </dt>
 
   </dl></td>
@@ -450,6 +462,10 @@
   </dt>
 
       
+  <dt><a href="pygit2.html#pygit2.Repository.TreeBuilder">TreeBuilder() (pygit2.Repository method)</a>
+  </dt>
+
+      
   <dt><a href="pygit2.html#pygit2.TreeEntry">TreeEntry (class in pygit2)</a>
   </dt>
 

pygit2.html

@@ -56,7 +56,8 @@
 <dl class="class">
 <dt id="pygit2.Blob">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Blob</tt><a class="headerlink" href="#pygit2.Blob" title="Permalink to this definition">¶</a></dt>
-<dd><p>Blob objects</p>
+<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
+<p>Blob objects</p>
 <dl class="attribute">
 <dt id="pygit2.Blob.data">
 <tt class="descname">data</tt><a class="headerlink" href="#pygit2.Blob.data" title="Permalink to this definition">¶</a></dt>
@@ -68,7 +69,8 @@
 <dl class="class">
 <dt id="pygit2.Commit">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Commit</tt><a class="headerlink" href="#pygit2.Commit" title="Permalink to this definition">¶</a></dt>
-<dd><p>Commit objects</p>
+<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
+<p>Commit objects</p>
 <dl class="attribute">
 <dt id="pygit2.Commit.author">
 <tt class="descname">author</tt><a class="headerlink" href="#pygit2.Commit.author" title="Permalink to this definition">¶</a></dt>
@@ -122,7 +124,8 @@
 <dl class="class">
 <dt id="pygit2.Index">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Index</tt><a class="headerlink" href="#pygit2.Index" title="Permalink to this definition">¶</a></dt>
-<dd><p>Index file</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Index file</p>
 <dl class="method">
 <dt id="pygit2.Index.add">
 <tt class="descname">add</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Index.add" title="Permalink to this definition">¶</a></dt>
@@ -164,7 +167,8 @@
 <dl class="class">
 <dt id="pygit2.IndexEntry">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">IndexEntry</tt><a class="headerlink" href="#pygit2.IndexEntry" title="Permalink to this definition">¶</a></dt>
-<dd><p>Index entry</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Index entry</p>
 <dl class="attribute">
 <dt id="pygit2.IndexEntry.hex">
 <tt class="descname">hex</tt><a class="headerlink" href="#pygit2.IndexEntry.hex" title="Permalink to this definition">¶</a></dt>
@@ -194,7 +198,8 @@
 <dl class="class">
 <dt id="pygit2.Object">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Object</tt><a class="headerlink" href="#pygit2.Object" title="Permalink to this definition">¶</a></dt>
-<dd><p>Object objects</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Object objects</p>
 <dl class="attribute">
 <dt id="pygit2.Object.hex">
 <tt class="descname">hex</tt><a class="headerlink" href="#pygit2.Object.hex" title="Permalink to this definition">¶</a></dt>
@@ -224,7 +229,8 @@
 <dl class="class">
 <dt id="pygit2.Reference">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Reference</tt><a class="headerlink" href="#pygit2.Reference" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reference</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Reference</p>
 <dl class="method">
 <dt id="pygit2.Reference.delete">
 <tt class="descname">delete</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Reference.delete" title="Permalink to this definition">¶</a></dt>
@@ -284,7 +290,20 @@
 <dl class="class">
 <dt id="pygit2.Repository">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Repository</tt><a class="headerlink" href="#pygit2.Repository" title="Permalink to this definition">¶</a></dt>
-<dd><p>Git repository</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Git repository</p>
+<dl class="method">
+<dt id="pygit2.Repository.TreeBuilder">
+<tt class="descname">TreeBuilder</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.TreeBuilder" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a TreeBuilder object for this repository.</p>
+</dd></dl>
+
+<dl class="method">
+<dt id="pygit2.Repository.create_blob">
+<tt class="descname">create_blob</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_blob" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a new blob from memory</p>
+</dd></dl>
+
 <dl class="method">
 <dt id="pygit2.Repository.create_commit">
 <tt class="descname">create_commit</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.create_commit" title="Permalink to this definition">¶</a></dt>
@@ -349,10 +368,16 @@
 <dl class="method">
 <dt id="pygit2.Repository.status">
 <tt class="descname">status</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.status" title="Permalink to this definition">¶</a></dt>
-<dd><p>Reads the status of the repository and returns a dictionnary with file paths as keys and status flags as values.
+<dd><p>Reads the status of the repository and returns a dictionary with file paths as keys and status flags as values.
 See pygit2.GIT_STATUS_*.</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="pygit2.Repository.status_file">
+<tt class="descname">status_file</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.status_file" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the status of the given file path.</p>
+</dd></dl>
+
 <dl class="method">
 <dt id="pygit2.Repository.walk">
 <tt class="descname">walk</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.Repository.walk" title="Permalink to this definition">¶</a></dt>
@@ -378,7 +403,8 @@ of the created object.</p>
 <dl class="class">
 <dt id="pygit2.Signature">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Signature</tt><a class="headerlink" href="#pygit2.Signature" title="Permalink to this definition">¶</a></dt>
-<dd><p>Signature</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>Signature</p>
 <dl class="attribute">
 <dt id="pygit2.Signature.email">
 <tt class="descname">email</tt><a class="headerlink" href="#pygit2.Signature.email" title="Permalink to this definition">¶</a></dt>
@@ -408,7 +434,8 @@ of the created object.</p>
 <dl class="class">
 <dt id="pygit2.Tag">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Tag</tt><a class="headerlink" href="#pygit2.Tag" title="Permalink to this definition">¶</a></dt>
-<dd><p>Tag objects</p>
+<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
+<p>Tag objects</p>
 <dl class="attribute">
 <dt id="pygit2.Tag.message">
 <tt class="descname">message</tt><a class="headerlink" href="#pygit2.Tag.message" title="Permalink to this definition">¶</a></dt>
@@ -438,13 +465,15 @@ of the created object.</p>
 <dl class="class">
 <dt id="pygit2.Tree">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">Tree</tt><a class="headerlink" href="#pygit2.Tree" title="Permalink to this definition">¶</a></dt>
-<dd><p>Tree objects</p>
+<dd><p>Bases: <a class="reference internal" href="#pygit2.Object" title="pygit2.Object"><tt class="xref py py-class docutils literal"><span class="pre">pygit2.Object</span></tt></a></p>
+<p>Tree objects</p>
 </dd></dl>
 
 <dl class="class">
 <dt id="pygit2.TreeEntry">
 <em class="property">class </em><tt class="descclassname">pygit2.</tt><tt class="descname">TreeEntry</tt><a class="headerlink" href="#pygit2.TreeEntry" title="Permalink to this definition">¶</a></dt>
-<dd><p>TreeEntry objects</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
+<p>TreeEntry objects</p>
 <dl class="attribute">
 <dt id="pygit2.TreeEntry.attributes">
 <tt class="descname">attributes</tt><a class="headerlink" href="#pygit2.TreeEntry.attributes" title="Permalink to this definition">¶</a></dt>
@@ -477,6 +506,12 @@ of the created object.</p>
 
 </dd></dl>
 
+<dl class="function">
+<dt id="pygit2.discover_repository">
+<tt class="descclassname">pygit2.</tt><tt class="descname">discover_repository</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.discover_repository" title="Permalink to this definition">¶</a></dt>
+<dd><p>Look for a git repository and return its path.</p>
+</dd></dl>
+
 <dl class="function">
 <dt id="pygit2.init_repository">
 <tt class="descclassname">pygit2.</tt><tt class="descname">init_repository</tt><big>(</big><big>)</big><a class="headerlink" href="#pygit2.init_repository" title="Permalink to this definition">¶</a></dt>

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&#8217;s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pygit2</span></tt>"],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"]})
+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&#8217;s documentation!","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pygit2</span></tt>"],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"]})