doc: update generated documentation (#77)

* Improve and fix documentation on domain package
* Add domain page
* Generate the docs

doc/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c8a4da0d08d0c500e60c29330945b947
+config: 617eff2a504851029351055fa70c295d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

doc/build/html/_sources/contents.rst.txt

@@ -28,4 +28,5 @@ this part of the documentation is for you.
 .. toctree::
    :maxdepth: 2
 
+   domain
    infrastructure

doc/build/html/_sources/domain.rst.txt

@@ -0,0 +1,57 @@
+.. _domain:
+
+The Sheriff Domain
+==================
+.. module:: thesheriff.domain
+
+This part of the documentation covers all interfaces on
+thesheriff.domain module.
+
+Gang
+----
+
+.. _gang:
+.. module:: thesheriff.domain.gang.gang
+.. autoclass:: Gang
+   :members:
+.. _gang_factory:
+.. module:: thesheriff.domain.gang.gang_factory
+.. autoclass:: GangFactory
+   :members:
+.. _gang_repository:
+.. module:: thesheriff.domain.gang.repository.gang_repository
+.. autoclass:: GangRepository
+   :members:
+
+Outlaw
+------
+
+.. _outlaw:
+.. module:: thesheriff.domain.outlaw.outlaw
+.. autoclass:: Outlaw
+   :members:
+.. _outlaw_factory:
+.. module:: thesheriff.domain.outlaw.outlaw_factory
+.. autoclass:: OutlawFactory
+   :members:
+.. _outlaw_repository:
+.. module:: thesheriff.domain.outlaw.repository.outlaw_repository
+.. autoclass:: OutlawRepository
+   :members:
+
+
+Raid
+----
+
+.. _raid:
+.. module:: thesheriff.domain.raid.raid
+.. autoclass:: Raid
+   :members:
+.. _raid_factory:
+.. module:: thesheriff.domain.raid.raid_factory
+.. autoclass:: RaidFactory
+   :members:
+.. _raid_repository:
+.. module:: thesheriff.domain.raid.repository.raid_repository
+.. autoclass:: RaidRepository
+   :members:

doc/build/html/contents.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>
 

doc/build/html/genindex.html

@@ -36,7 +36,9 @@ <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
  <a href="#A"><strong>A</strong></a>
+ | <a href="#C"><strong>C</strong></a>
  | <a href="#G"><strong>G</strong></a>
+ | <a href="#J"><strong>J</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#O"><strong>O</strong></a>
  | <a href="#R"><strong>R</strong></a>
@@ -57,26 +59,66 @@ <h2 id="A">A</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.gang.gang.Gang.add_members">add_members() (thesheriff.domain.gang.gang.Gang method)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.raid.raid.Raid.add_rate">add_rate() (thesheriff.domain.raid.raid.Raid method)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.repository.mysql_gang_repository.MySQLGangRepository.all">all() (thesheriff.infrastructure.repository.mysql_gang_repository.MySQLGangRepository method)</a>
 </li>
   </ul></td>
 </tr></table>
 
+<h2 id="C">C</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.raid.raid.Raid.could_finish">could_finish() (thesheriff.domain.raid.raid.Raid method)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.gang.gang_factory.GangFactory.create">create() (thesheriff.domain.gang.gang_factory.GangFactory static method)</a>
+
+      <ul>
+        <li><a href="domain.html#thesheriff.domain.outlaw.outlaw_factory.OutlawFactory.create">(thesheriff.domain.outlaw.outlaw_factory.OutlawFactory static method)</a>
+</li>
+        <li><a href="domain.html#thesheriff.domain.raid.raid_factory.RaidFactory.create">(thesheriff.domain.raid.raid_factory.RaidFactory static method)</a>
+</li>
+      </ul></li>
+  </ul></td>
+</tr></table>
+
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.gang.gang.Gang">Gang (class in thesheriff.domain.gang.gang)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.controllers.gang_controller.gang_controller">gang_controller() (in module thesheriff.infrastructure.controllers.gang_controller)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.gang.gang_factory.GangFactory">GangFactory (class in thesheriff.domain.gang.gang_factory)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.gang.repository.gang_repository.GangRepository">GangRepository (class in thesheriff.domain.gang.repository.gang_repository)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.repository.mysql_outlaw_repository.MySQLOutlawRepository.get_friends">get_friends() (thesheriff.infrastructure.repository.mysql_outlaw_repository.MySQLOutlawRepository method)</a>
 </li>
   </ul></td>
 </tr></table>
 
+<h2 id="J">J</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.raid.raid.Raid.join">join() (thesheriff.domain.raid.raid.Raid method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw.join_gang">join_gang() (thesheriff.domain.outlaw.outlaw.Outlaw method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.gang.gang.Gang.members">members() (thesheriff.domain.gang.gang.Gang method)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.repository.mysql_gang_repository.MySQLGangRepository">MySQLGangRepository (class in thesheriff.infrastructure.repository.mysql_gang_repository)</a>
 </li>
   </ul></td>
@@ -101,18 +143,30 @@ <h2 id="O">O</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw">Outlaw (class in thesheriff.domain.outlaw.outlaw)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.controllers.outlaw_controller.outlaw_controller">outlaw_controller() (in module thesheriff.infrastructure.controllers.outlaw_controller)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.outlaw.outlaw_factory.OutlawFactory">OutlawFactory (class in thesheriff.domain.outlaw.outlaw_factory)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.outlaw.repository.outlaw_repository.OutlawRepository">OutlawRepository (class in thesheriff.domain.outlaw.repository.outlaw_repository)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.raid.raid.Raid">Raid (class in thesheriff.domain.raid.raid)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.controllers.raid_controller.raid_controller">raid_controller() (in module thesheriff.infrastructure.controllers.raid_controller)</a>
+</li>
+      <li><a href="domain.html#thesheriff.domain.raid.raid_factory.RaidFactory">RaidFactory (class in thesheriff.domain.raid.raid_factory)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#thesheriff.domain.raid.repository.raid_repository.RaidRepository">RaidRepository (class in thesheriff.domain.raid.repository.raid_repository)</a>
+</li>
       <li><a href="infrastructure.html#thesheriff.infrastructure.repository.mysql_gang_repository.MySQLGangRepository.remove">remove() (thesheriff.infrastructure.repository.mysql_gang_repository.MySQLGangRepository method)</a>
 
       <ul>
@@ -125,14 +179,34 @@ <h2 id="R">R</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#module-thesheriff.domain">thesheriff.domain (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.gang.gang">thesheriff.domain.gang.gang (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.gang.gang_factory">thesheriff.domain.gang.gang_factory (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.gang.repository.gang_repository">thesheriff.domain.gang.repository.gang_repository (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.outlaw.outlaw">thesheriff.domain.outlaw.outlaw (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.outlaw.outlaw_factory">thesheriff.domain.outlaw.outlaw_factory (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.outlaw.repository.outlaw_repository">thesheriff.domain.outlaw.repository.outlaw_repository (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.raid.raid">thesheriff.domain.raid.raid (module)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="domain.html#module-thesheriff.domain.raid.raid_factory">thesheriff.domain.raid.raid_factory (module)</a>
+</li>
+      <li><a href="domain.html#module-thesheriff.domain.raid.repository.raid_repository">thesheriff.domain.raid.repository.raid_repository (module)</a>
+</li>
       <li><a href="infrastructure.html#module-thesheriff.infrastructure">thesheriff.infrastructure (module)</a>
 </li>
       <li><a href="infrastructure.html#module-thesheriff.infrastructure.controllers.gang_controller">thesheriff.infrastructure.controllers.gang_controller (module)</a>
 </li>
       <li><a href="infrastructure.html#module-thesheriff.infrastructure.controllers.outlaw_controller">thesheriff.infrastructure.controllers.outlaw_controller (module)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="infrastructure.html#module-thesheriff.infrastructure.controllers.raid_controller">thesheriff.infrastructure.controllers.raid_controller (module)</a>
 </li>
       <li><a href="infrastructure.html#module-thesheriff.infrastructure.repository.mysql_gang_repository">thesheriff.infrastructure.repository.mysql_gang_repository (module)</a>
@@ -183,6 +257,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>
 

doc/build/html/infrastructure.html

@@ -14,7 +14,7 @@
     <script type="text/javascript" src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="The Sheriff Usage" href="usage.html" />
+    <link rel="prev" title="The Sheriff Domain" href="domain.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -220,7 +220,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd><p>Method add persists a new Gang to MySQL.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>new_gang</strong> (<em>Gang</em>) – Object with the new Gang details.</p>
+<dd class="field-odd"><p><strong>new_gang</strong> (<a class="reference internal" href="domain.html#thesheriff.domain.gang.gang.Gang" title="thesheriff.domain.gang.gang.Gang"><em>Gang</em></a>) – Object with the new Gang details.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>No returned value.</p>
@@ -240,7 +240,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd class="field-odd"><p>List Gang objects.</p>
 </dd>
 <dt class="field-even">Return type</dt>
-<dd class="field-even"><p>List[Gang]</p>
+<dd class="field-even"><p>List[<a class="reference internal" href="domain.html#thesheriff.domain.gang.gang.Gang" title="thesheriff.domain.gang.gang.Gang">Gang</a>]</p>
 </dd>
 </dl>
 </dd></dl>
@@ -257,7 +257,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd class="field-even"><p>Gang object.</p>
 </dd>
 <dt class="field-odd">Return type</dt>
-<dd class="field-odd"><p>Gang</p>
+<dd class="field-odd"><p><a class="reference internal" href="domain.html#thesheriff.domain.gang.gang.Gang" title="thesheriff.domain.gang.gang.Gang">Gang</a></p>
 </dd>
 </dl>
 </dd></dl>
@@ -285,7 +285,7 @@ <h2>Repositories<a class="headerlink" href="#repositories" title="Permalink to t
 <dd><p>Method update modifies existing Gang.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>mod_gang</strong> (<em>Gang</em>) – Object with Gang details to be updated.</p>
+<dd class="field-odd"><p><strong>mod_gang</strong> (<a class="reference internal" href="domain.html#thesheriff.domain.gang.gang.Gang" title="thesheriff.domain.gang.gang.Gang"><em>Gang</em></a>) – Object with Gang details to be updated.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>No returned value.</p>
@@ -475,6 +475,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="usage.html">The Sheriff Usage</a></li>
 </ul>
 <ul class="current">
+<li class="toctree-l1"><a class="reference internal" href="domain.html">The Sheriff Domain</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">The Sheriff Infrastructure</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#controllers">Controllers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#repositories">Repositories</a></li>
@@ -493,7 +494,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <ul>
   <li><a href="contents.html">Documentation overview</a><ul>
-      <li>Previous: <a href="usage.html" title="previous chapter">The Sheriff Usage</a></li>
+      <li>Previous: <a href="domain.html" title="previous chapter">The Sheriff Domain</a></li>
   </ul></li>
 </ul>
 </div>

doc/build/html/py-modindex.html

@@ -50,6 +50,56 @@ <h1>Python Module Index</h1>
        <td>
        <code class="xref">thesheriff</code></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain"><code class="xref">thesheriff.domain</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.gang.gang"><code class="xref">thesheriff.domain.gang.gang</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.gang.gang_factory"><code class="xref">thesheriff.domain.gang.gang_factory</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.gang.repository.gang_repository"><code class="xref">thesheriff.domain.gang.repository.gang_repository</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.outlaw.outlaw"><code class="xref">thesheriff.domain.outlaw.outlaw</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.outlaw.outlaw_factory"><code class="xref">thesheriff.domain.outlaw.outlaw_factory</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.outlaw.repository.outlaw_repository"><code class="xref">thesheriff.domain.outlaw.repository.outlaw_repository</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.raid.raid"><code class="xref">thesheriff.domain.raid.raid</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.raid.raid_factory"><code class="xref">thesheriff.domain.raid.raid_factory</code></a></td><td>
+       <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="domain.html#module-thesheriff.domain.raid.repository.raid_repository"><code class="xref">thesheriff.domain.raid.repository.raid_repository</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -111,6 +161,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>
 

doc/build/html/search.html

@@ -82,6 +82,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>