doc: add application package documentation (#79)

* Add and/or improve modules documentation
* Add domain.rst file linked on index.rst
* Generate HTML pages

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

@@ -0,0 +1,60 @@
+.. _application:
+
+The Sheriff Application
+=======================
+.. module:: thesheriff.application
+
+This part of the documentation covers all interfaces on
+thesheriff.application module.
+
+Gang
+----
+
+.. _join_gang_request:
+.. module:: thesheriff.application.gang.request.join_gang_request
+.. autoclass:: JoinGangRequest
+   :members:
+
+Outlaw
+------
+
+.. _create_gang:
+.. module:: thesheriff.application.outlaw.create_gang
+.. autoclass:: CreateGang
+   :members:
+.. _create_outlaw:
+.. module:: thesheriff.application.outlaw.create_outlaw
+.. autoclass:: CreateOutlaw
+   :members:
+.. _join_gang:
+.. module:: thesheriff.application.outlaw.join_gang
+.. autoclass:: JoinGang
+   :members:
+.. _list_friends:
+.. module:: thesheriff.application.outlaw.list_friends
+.. autoclass:: ListFriends
+   :members:
+.. _list_gangs:
+.. module:: thesheriff.application.outlaw.list_gangs
+.. autoclass:: ListGangs
+   :members:
+.. _rate_raid:
+.. module:: thesheriff.application.outlaw.rate_raid
+.. autoclass:: RateRaid
+   :members:
+.. _create_outlaw_request:
+.. module:: thesheriff.application.outlaw.request.create_outlaw_request
+.. autoclass:: CreateOutlawRequest
+   :members:
+
+Raid
+----
+
+.. _end_raid:
+.. module:: thesheriff.application.raid.end_raid
+.. autoclass:: EndRaid
+   :members:
+.. _grade_raid:
+.. module:: thesheriff.application.raid.grade_raid
+.. autoclass:: GradeRaid
+   :members:

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

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

doc/build/html/domain.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="The Sheriff Infrastructure" href="infrastructure.html" />
-    <link rel="prev" title="The Sheriff Usage" href="usage.html" />
+    <link rel="prev" title="The Sheriff Application" href="application.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -317,6 +317,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="application.html">The Sheriff Application</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">The Sheriff Domain</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#gang">Gang</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#outlaw">Outlaw</a></li>
@@ -337,7 +338,7 @@ <h3>Navigation</h3>
 <h3>Related Topics</h3>
 <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>Previous: <a href="application.html" title="previous chapter">The Sheriff Application</a></li>
       <li>Next: <a href="infrastructure.html" title="next chapter">The Sheriff Infrastructure</a></li>
   </ul></li>
 </ul>

doc/build/html/genindex.html

@@ -37,8 +37,10 @@ <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="#E"><strong>E</strong></a>
  | <a href="#G"><strong>G</strong></a>
  | <a href="#J"><strong>J</strong></a>
+ | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#O"><strong>O</strong></a>
  | <a href="#R"><strong>R</strong></a>
@@ -79,6 +81,40 @@ <h2 id="C">C</h2>
         <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>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="application.html#thesheriff.application.outlaw.create_gang.CreateGang">CreateGang (class in thesheriff.application.outlaw.create_gang)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.outlaw.create_outlaw.CreateOutlaw">CreateOutlaw (class in thesheriff.application.outlaw.create_outlaw)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.outlaw.request.create_outlaw_request.CreateOutlawRequest">CreateOutlawRequest (class in thesheriff.application.outlaw.request.create_outlaw_request)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="E">E</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="application.html#thesheriff.application.raid.end_raid.EndRaid">EndRaid (class in thesheriff.application.raid.end_raid)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.outlaw.create_gang.CreateGang.execute">execute() (thesheriff.application.outlaw.create_gang.CreateGang method)</a>
+
+      <ul>
+        <li><a href="application.html#thesheriff.application.outlaw.create_outlaw.CreateOutlaw.execute">(thesheriff.application.outlaw.create_outlaw.CreateOutlaw method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.outlaw.join_gang.JoinGang.execute">(thesheriff.application.outlaw.join_gang.JoinGang method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.outlaw.list_friends.ListFriends.execute">(thesheriff.application.outlaw.list_friends.ListFriends method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.outlaw.list_gangs.ListGangs.execute">(thesheriff.application.outlaw.list_gangs.ListGangs method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.outlaw.rate_raid.RateRaid.execute">(thesheriff.application.outlaw.rate_raid.RateRaid method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.raid.end_raid.EndRaid.execute">(thesheriff.application.raid.end_raid.EndRaid method)</a>
+</li>
+        <li><a href="application.html#thesheriff.application.raid.grade_raid.GradeRaid.execute">(thesheriff.application.raid.grade_raid.GradeRaid method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -91,13 +127,15 @@ <h2 id="G">G</h2>
 </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>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <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>
+      <li><a href="application.html#thesheriff.application.raid.grade_raid.GradeRaid">GradeRaid (class in thesheriff.application.raid.grade_raid)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -106,10 +144,26 @@ <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>
+      <li><a href="domain.html#thesheriff.domain.outlaw.outlaw.Outlaw.join_gang">join_gang() (thesheriff.domain.outlaw.outlaw.Outlaw 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><a href="application.html#thesheriff.application.outlaw.join_gang.JoinGang">JoinGang (class in thesheriff.application.outlaw.join_gang)</a>
+</li>
+      <li><a href="application.html#thesheriff.application.gang.request.join_gang_request.JoinGangRequest">JoinGangRequest (class in thesheriff.application.gang.request.join_gang_request)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="application.html#thesheriff.application.outlaw.list_friends.ListFriends">ListFriends (class in thesheriff.application.outlaw.list_friends)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="application.html#thesheriff.application.outlaw.list_gangs.ListGangs">ListGangs (class in thesheriff.application.outlaw.list_gangs)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -166,6 +220,8 @@ <h2 id="R">R</h2>
   </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="application.html#thesheriff.application.outlaw.rate_raid.RateRaid">RateRaid (class in thesheriff.application.outlaw.rate_raid)</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>
 
@@ -179,12 +235,36 @@ <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="application.html#module-thesheriff.application">thesheriff.application (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.gang.request.join_gang_request">thesheriff.application.gang.request.join_gang_request (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.create_gang">thesheriff.application.outlaw.create_gang (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.create_outlaw">thesheriff.application.outlaw.create_outlaw (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.join_gang">thesheriff.application.outlaw.join_gang (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.list_friends">thesheriff.application.outlaw.list_friends (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.list_gangs">thesheriff.application.outlaw.list_gangs (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.rate_raid">thesheriff.application.outlaw.rate_raid (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.outlaw.request.create_outlaw_request">thesheriff.application.outlaw.request.create_outlaw_request (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.raid.end_raid">thesheriff.application.raid.end_raid (module)</a>
+</li>
+      <li><a href="application.html#module-thesheriff.application.raid.grade_raid">thesheriff.application.raid.grade_raid (module)</a>
+</li>
       <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>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <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>
@@ -195,8 +275,6 @@ <h2 id="T">T</h2>
 </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>
@@ -257,6 +335,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="application.html">The Sheriff Application</a></li>
 <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/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="application.html">The Sheriff Application</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="application.html#gang">Gang</a></li>
+<li class="toctree-l2"><a class="reference internal" href="application.html#outlaw">Outlaw</a></li>
+<li class="toctree-l2"><a class="reference internal" href="application.html#raid">Raid</a></li>
+</ul>
+</li>
 <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>
@@ -95,6 +101,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="application.html">The Sheriff Application</a></li>
 <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

@@ -44,8 +44,8 @@ <h2>Controllers<a class="headerlink" href="#controllers" title="Permalink to thi
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>join_gang</strong> (<em>JoinGang</em>) – Join Gang use case implementation.</p></li>
-<li><p><strong>create_gang</strong> (<em>CreateGang</em>) – Create Gang use case implementation.</p></li>
+<li><p><strong>join_gang</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.join_gang.JoinGang" title="thesheriff.application.outlaw.join_gang.JoinGang"><em>JoinGang</em></a>) – Join Gang use case implementation.</p></li>
+<li><p><strong>create_gang</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.create_gang.CreateGang" title="thesheriff.application.outlaw.create_gang.CreateGang"><em>CreateGang</em></a>) – Create Gang use case implementation.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -100,9 +100,9 @@ <h3>thesheriff.infrastructure.controllers.outlaw_controller<a class="headerlink"
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>create_outlaw</strong> (<em>CreateOutlaw</em>) – Create Outlaw use case implementation.</p></li>
-<li><p><strong>list_friends</strong> (<em>ListFriends</em>) – List Friends use case implementation.</p></li>
-<li><p><strong>list_gangs</strong> (<em>ListGangs</em>) – List Gangs use case implementation.</p></li>
+<li><p><strong>create_outlaw</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.create_outlaw.CreateOutlaw" title="thesheriff.application.outlaw.create_outlaw.CreateOutlaw"><em>CreateOutlaw</em></a>) – Create Outlaw use case implementation.</p></li>
+<li><p><strong>list_friends</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.list_friends.ListFriends" title="thesheriff.application.outlaw.list_friends.ListFriends"><em>ListFriends</em></a>) – List Friends use case implementation.</p></li>
+<li><p><strong>list_gangs</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.list_gangs.ListGangs" title="thesheriff.application.outlaw.list_gangs.ListGangs"><em>ListGangs</em></a>) – List Gangs use case implementation.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -189,7 +189,7 @@ <h3>thesheriff.infrastructure.controllers.raid_controller<a class="headerlink" h
 <dd><p>raid_controller holds the blueprint for all raid routes.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
-<dd class="field-odd"><p><strong>rate_raid</strong> (<em>RateRaid</em>) – RateRaid use case implementation.</p>
+<dd class="field-odd"><p><strong>rate_raid</strong> (<a class="reference internal" href="application.html#thesheriff.application.outlaw.rate_raid.RateRaid" title="thesheriff.application.outlaw.rate_raid.RateRaid"><em>RateRaid</em></a>) – RateRaid use case implementation.</p>
 </dd>
 <dt class="field-even">Returns</dt>
 <dd class="field-even"><p>Flask Blueprint.</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="application.html">The Sheriff Application</a></li>
 <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>