doc: fix reathedocs integration (#78)

* Back to use index.rst instead of contents.rst
tripledes · Dec 23, 2019 · 9fa7c7c · 9fa7c7c
1 parent 23587c7
commit 9fa7c7c
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 215 deletions.
diff --git a/doc/build/doctrees/contents.doctree b/doc/build/doctrees/contents.doctree
diff --git a/doc/build/doctrees/environment.pickle b/doc/build/doctrees/environment.pickle
diff --git a/doc/build/doctrees/index.doctree b/doc/build/doctrees/index.doctree
diff --git a/doc/build/html/_sources/index.rst.txt b/doc/build/html/_sources/index.rst.txt
@@ -28,4 +28,5 @@ this part of the documentation is for you.
 .. toctree::
    :maxdepth: 2
 
+   domain
    infrastructure
diff --git a/doc/build/html/contents.html b/doc/build/html/contents.html
diff --git a/doc/build/html/domain.html b/doc/build/html/domain.html
@@ -300,10 +300,10 @@ <h2>Raid<a class="headerlink" href="#raid" title="Permalink to this headline">¶
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-            <p class="logo"><a href="contents.html">
+            <p class="logo"><a href="index.html">
               <img class="logo" src="_static/logo.png" alt="Logo"/>
             </a></p>
-<h1 class="logo"><a href="contents.html">The Sheriff</a></h1>
+<h1 class="logo"><a href="index.html">The Sheriff</a></h1>
 
 
 
@@ -336,7 +336,7 @@ <h3>Navigation</h3>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="contents.html">Documentation overview</a><ul>
+  <li><a href="index.html">Documentation overview</a><ul>
       <li>Previous: <a href="usage.html" title="previous chapter">The Sheriff Usage</a></li>
       <li>Next: <a href="infrastructure.html" title="next chapter">The Sheriff Infrastructure</a></li>
   </ul></li>

diff --git a/doc/build/html/genindex.html b/doc/build/html/genindex.html
@@ -240,10 +240,10 @@ <h2 id="U">U</h2>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-            <p class="logo"><a href="contents.html">
+            <p class="logo"><a href="index.html">
               <img class="logo" src="_static/logo.png" alt="Logo"/>
             </a></p>
-<h1 class="logo"><a href="contents.html">The Sheriff</a></h1>
+<h1 class="logo"><a href="index.html">The Sheriff</a></h1>
 
 
 
@@ -271,7 +271,7 @@ <h3>Navigation</h3>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="contents.html">Documentation overview</a><ul>
+  <li><a href="index.html">Documentation overview</a><ul>
   </ul></li>
 </ul>
 </div>

diff --git a/doc/build/html/index.html b/doc/build/html/index.html
@@ -55,6 +55,12 @@ <h2>The API Documentation<a class="headerlink" href="#the-api-documentation" tit
 this part of the documentation is for you.</p>
 <div class="toctree-wrapper compound">
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="domain.html">The Sheriff Domain</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="domain.html#gang">Gang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="domain.html#outlaw">Outlaw</a></li>
+<li class="toctree-l2"><a class="reference internal" href="domain.html#raid">Raid</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="infrastructure.html">The Sheriff Infrastructure</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="infrastructure.html#controllers">Controllers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="infrastructure.html#repositories">Repositories</a></li>
@@ -89,6 +95,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">The Sheriff Usage</a></li>
 </ul>
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="domain.html">The Sheriff Domain</a></li>
 <li class="toctree-l1"><a class="reference internal" href="infrastructure.html">The Sheriff Infrastructure</a></li>
 </ul>
 

diff --git a/doc/build/html/infrastructure.html b/doc/build/html/infrastructure.html
@@ -313,7 +313,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd><p>Method add persists a new Outlaw to MySQL.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>new_outlaw</strong> (<em>Outlaw</em>) – Object with the new Outlaw details</p>
+<dd class="field-odd"><p><strong>new_outlaw</strong> (<a class="reference internal" href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw" title="thesheriff.domain.outlaw.outlaw.Outlaw"><em>Outlaw</em></a>) – Object with the new Outlaw details</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>No returned value.</p>
@@ -336,7 +336,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd class="field-even"><p>List of outlaw friends.</p>
 </dd>
 <dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p>List[Outlaw]</p>
+<dd class="field-odd"><p>List[<a class="reference internal" href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw" title="thesheriff.domain.outlaw.outlaw.Outlaw">Outlaw</a>]</p>
 </dd>
 </dl>
 </dd></dl>
@@ -353,7 +353,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd class="field-even"><p>Outlaw object.</p>
 </dd>
 <dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p>Outlaw</p>
+<dd class="field-odd"><p><a class="reference internal" href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw" title="thesheriff.domain.outlaw.outlaw.Outlaw">Outlaw</a></p>
 </dd>
 </dl>
 </dd></dl>
@@ -381,7 +381,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd><p>Method update modifies existing Outlaw.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>mod_outlaw</strong> (<em>Outlaw</em>) – Object with Outlaw details to be updated.</p>
+<dd class="field-odd"><p><strong>mod_outlaw</strong> (<a class="reference internal" href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw" title="thesheriff.domain.outlaw.outlaw.Outlaw"><em>Outlaw</em></a>) – Object with Outlaw details to be updated.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>No returned value.</p>
@@ -409,7 +409,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd><p>Method add persists a new Outlaw to MySQL.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>new_outlaw</strong> (<em>Outlaw</em>) – Object with the Outlaw information.</p>
+<dd class="field-odd"><p><strong>new_outlaw</strong> (<a class="reference internal" href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw" title="thesheriff.domain.outlaw.outlaw.Outlaw"><em>Outlaw</em></a>) – Object with the Outlaw information.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>No returned value.</p>
@@ -432,7 +432,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd class="field-even"><p>The Raid matching raid_id.</p>
 </dd>
 <dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p>Raid</p>
+<dd class="field-odd"><p><a class="reference internal" href="domain.html#thesheriff.domain.raid.raid.Raid" title="thesheriff.domain.raid.raid.Raid">Raid</a></p>
 </dd>
 </dl>
 </dd></dl>
@@ -458,10 +458,10 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-            <p class="logo"><a href="contents.html">
+            <p class="logo"><a href="index.html">
               <img class="logo" src="_static/logo.png" alt="Logo"/>
             </a></p>
-<h1 class="logo"><a href="contents.html">The Sheriff</a></h1>
+<h1 class="logo"><a href="index.html">The Sheriff</a></h1>
 
 
 
@@ -493,7 +493,7 @@ <h3>Navigation</h3>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="contents.html">Documentation overview</a><ul>
+  <li><a href="index.html">Documentation overview</a><ul>
       <li>Previous: <a href="domain.html" title="previous chapter">The Sheriff Domain</a></li>
   </ul></li>
 </ul>

diff --git a/doc/build/html/objects.inv b/doc/build/html/objects.inv
diff --git a/doc/build/html/py-modindex.html b/doc/build/html/py-modindex.html
@@ -144,10 +144,10 @@ <h1>Python Module Index</h1>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-            <p class="logo"><a href="contents.html">
+            <p class="logo"><a href="index.html">
               <img class="logo" src="_static/logo.png" alt="Logo"/>
             </a></p>
-<h1 class="logo"><a href="contents.html">The Sheriff</a></h1>
+<h1 class="logo"><a href="index.html">The Sheriff</a></h1>
 
 
 
@@ -175,7 +175,7 @@ <h3>Navigation</h3>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="contents.html">Documentation overview</a><ul>
+  <li><a href="index.html">Documentation overview</a><ul>
   </ul></li>
 </ul>
 </div>

diff --git a/doc/build/html/search.html b/doc/build/html/search.html
@@ -65,10 +65,10 @@ <h1 id="search-documentation">Search</h1>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-            <p class="logo"><a href="contents.html">
+            <p class="logo"><a href="index.html">
               <img class="logo" src="_static/logo.png" alt="Logo"/>
             </a></p>
-<h1 class="logo"><a href="contents.html">The Sheriff</a></h1>
+<h1 class="logo"><a href="index.html">The Sheriff</a></h1>
 
 
 
@@ -96,7 +96,7 @@ <h3>Navigation</h3>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="contents.html">Documentation overview</a><ul>
+  <li><a href="index.html">Documentation overview</a><ul>
   </ul></li>
 </ul>
 </div>