Updating documentation.

menegazzo · Jul 4, 2014 · ae3967a · ae3967a
1 parent 9b18d2a
commit ae3967a
Show file tree

Hide file tree

Showing 24 changed files with 1,342 additions and 992 deletions.
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/entities.doctree b/docs/_build/doctrees/entities.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/getting_started.doctree b/docs/_build/doctrees/getting_started.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/_modules/travispy/entities/_entity.html b/docs/_build/html/_modules/travispy/entities/_entity.html
@@ -68,7 +68,7 @@ <h1>Source code for travispy.entities._entity</h1><div class="highlight"><pre>
 <span class="c">#===================================================================================================</span>
 <span class="c"># Entity</span>
 <span class="c">#===================================================================================================</span>
-<div class="viewcode-block" id="Entity"><a class="viewcode-back" href="../../../index.html#travispy.entities._entity.Entity">[docs]</a><span class="k">class</span> <span class="nc">Entity</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+<div class="viewcode-block" id="Entity"><a class="viewcode-back" href="../../../entities.html#travispy.entities._entity.Entity">[docs]</a><span class="k">class</span> <span class="nc">Entity</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
     <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">    Base class for all |travisci| entities.</span>
 
@@ -90,7 +90,7 @@ <h1>Source code for travispy.entities._entity</h1><div class="highlight"><pre>
 
 
     <span class="nd">@classmethod</span>
-<div class="viewcode-block" id="Entity.one"><a class="viewcode-back" href="../../../index.html#travispy.entities._entity.Entity.one">[docs]</a>    <span class="k">def</span> <span class="nf">one</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+<div class="viewcode-block" id="Entity.one"><a class="viewcode-back" href="../../../entities.html#travispy.entities._entity.Entity.one">[docs]</a>    <span class="k">def</span> <span class="nf">one</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">        :rtype: str</span>
 <span class="sd">        :returns:</span>
@@ -101,7 +101,7 @@ <h1>Source code for travispy.entities._entity</h1><div class="highlight"><pre>
 
 </div>
     <span class="nd">@classmethod</span>
-<div class="viewcode-block" id="Entity.many"><a class="viewcode-back" href="../../../index.html#travispy.entities._entity.Entity.many">[docs]</a>    <span class="k">def</span> <span class="nf">many</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
+<div class="viewcode-block" id="Entity.many"><a class="viewcode-back" href="../../../entities.html#travispy.entities._entity.Entity.many">[docs]</a>    <span class="k">def</span> <span class="nf">many</span><span class="p">(</span><span class="n">cls</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">        :rtype: str</span>
 <span class="sd">        :returns:</span>

diff --git a/docs/_build/html/_modules/travispy/entities/_restartable.html b/docs/_build/html/_modules/travispy/entities/_restartable.html
@@ -72,12 +72,12 @@ <h1>Source code for travispy.entities._restartable</h1><div class="highlight"><p
 <span class="c">#===================================================================================================</span>
 <span class="c"># Restartable</span>
 <span class="c">#===================================================================================================</span>
-<div class="viewcode-block" id="Restartable"><a class="viewcode-back" href="../../../index.html#travispy.entities._restartable.Restartable">[docs]</a><span class="k">class</span> <span class="nc">Restartable</span><span class="p">(</span><span class="n">Entity</span><span class="p">):</span>
+<div class="viewcode-block" id="Restartable"><a class="viewcode-back" href="../../../entities.html#travispy.entities._restartable.Restartable">[docs]</a><span class="k">class</span> <span class="nc">Restartable</span><span class="p">(</span><span class="n">Entity</span><span class="p">):</span>
     <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">    Base class for restartable entities such as :class:`.Build` and :class:`.Job`.</span>
 <span class="sd">    &#39;&#39;&#39;</span>
 
-<div class="viewcode-block" id="Restartable.cancel"><a class="viewcode-back" href="../../../index.html#travispy.entities._restartable.Restartable.cancel">[docs]</a>    <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<div class="viewcode-block" id="Restartable.cancel"><a class="viewcode-back" href="../../../entities.html#travispy.entities._restartable.Restartable.cancel">[docs]</a>    <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">        Method responsible for canceling current action of this object.</span>
 
@@ -89,7 +89,7 @@ <h1>Source code for travispy.entities._restartable</h1><div class="highlight"><p
         <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">204</span>
 
 </div>
-<div class="viewcode-block" id="Restartable.restart"><a class="viewcode-back" href="../../../index.html#travispy.entities._restartable.Restartable.restart">[docs]</a>    <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<div class="viewcode-block" id="Restartable.restart"><a class="viewcode-back" href="../../../entities.html#travispy.entities._restartable.Restartable.restart">[docs]</a>    <span class="k">def</span> <span class="nf">restart</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">        Method responsible for restarting the last action executed by this action.</span>