Feature/documentation introduction (#103)

* Introduction done

* Introduction done and files generated

* Introduction finished

* Introduction and index modified

* Typo fixed

* Introduction done

* Introduction done and files generated

* fixing conflicts

* Typo fixed

* Branch updated prepared to merge

* Visual error fixed

* header fixed

Pipfile

@@ -5,7 +5,7 @@ verify_ssl = true
 
 [dev-packages]
 autopep8 = "*"
-sphinx = "==2.2.0"
+sphinx = "==2.3.1"
 pytest = "==5.3.1"
 pycodestyle = "*"
 

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

@@ -6,21 +6,47 @@
 Welcome to The Sheriff's documentation!
 =======================================
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
 
 
-Application usage
------------------
+Introduction
+============
+
+This part of the documentation is intended to birefly introduce
+The Sheriff application.
+
+.. toctree::
+   introduction
+
+Functionality - Application usage
+=================================
 
 Here's all you need to run and test The Sheriff application.
 
 .. toctree::
     usage
 
+Design - Hexagonal Architecture
+===============================
+Missing explanation of why we choose this architecture
+
+- The Sheriff Application
+
+Application contains the main use cases identified by the team and also auxiliary use cases:
+List gangs, create a gang, create an outlaw, invite a friend, join a gang, list friends, list gangs, rate the raid and
+send notifications.
+On this layer we also put the request classes, that are created on the controller, containing all necessary
+information to execute the use cases
+
+- The Sheriff Domain
+
+Here we put our domain classes (Outlaw, Gang and Raid) containing all pertinent business logic and the factory classes.
+
+- The Sheriff Infraestructure
+
+Contains the REST API endpoints and MySQL repositories
+
 The API Documentation
----------------------
+=====================
 
 If you are looking for information on a specific function, class, or method,
 this part of the documentation is for you.

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

@@ -0,0 +1,55 @@
+The Sheriff
+==========================
+
+This part of the documentation is intended to birefly introduce
+The Sheriff application.
+
+Introduction
+==========================
+
+**The Sheriff** is an exciting game application about an **outlaw** that
+goes out to eat with his **gang friends** in some restaurant. Along the game,
+the player will be able to **organize raids** in any restaurant, **create new gangs** and
+**many more features**!
+
+This game is created by the the company *StartupZ*, leaded by Fran Mangas,
+who bring the business project, and developed by *The Sheriff Team*, a group of Software
+Engineers from the *Evil Corp* consulting company, composed by Tatiana Bagnara,
+Diego Zavaleta, Ricardo Muhamed, Sergi Jimenez and Quim Nadal.
+
+
+The goal of doing this project is to **learn**, **apply** and later **evaluate** what the *Evil Corp*
+developers learnt in *Diseño Software 1* subject:
+
+1. **Clean code technics**
+
+2. **Creational, structural and behavioral patterns**
+
+3. **SOLID principles.**
+
+*The Sheriff* is an activity contained in *Diseño Software 1* subject, done in the first semester of the
+*Master en Desarrollo y Arquitectura de Software* degree, in *La Salle, Universitat Ramón
+Llull* university.
+
+
+Document Contents
+-----------------
+
+In all the other sections basically it is going to be explained the next information:
+
+- **Functionality - The Sheriff usage**: How to run the application, how to run the code static analysis,
+how to test the application and the tools needed for it.
+
+- **Design - Hexagonal architecture**: How the project is designed.
+    - **The Sheriff Aplication**
+    - **The Sheriff Domain**
+    - **The Sheriff Infraestructure**
+
+- **API Documentation**: To check the information on a specific function, class, or method.
+
+- **Conclusions**
+
+
+
+
+**Have fun!**

doc/build/html/_static/basic.css

@@ -672,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
     margin-top: 0;
 }
 
+div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
+    user-select: none;
+}
+
 div.code-block-caption span.caption-number {
     padding: 0.1em 0.3em;
     font-style: italic;

doc/build/html/_static/documentation_options.js

@@ -3,6 +3,7 @@ var DOCUMENTATION_OPTIONS = {
     VERSION: '1.0.0',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
+    BUILDER: 'html',
     FILE_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',

doc/build/html/_static/searchtools.js

@@ -245,7 +245,7 @@ var Search = {
       if (results.length) {
         var item = results.pop();
         var listItem = $('<li style="display:none"></li>');
-        if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
+        if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
           // dirhtml builder
           var dirname = item[0] + '/';
           if (dirname.match(/\/index\/$/)) {
@@ -424,15 +424,15 @@ var Search = {
         for (j = 0; j < _files.length; j++) {
           file = _files[j];
           if (!(file in scoreMap))
-            scoreMap[file] = {}
+            scoreMap[file] = {};
           scoreMap[file][word] = o.score;
         }
       });
 
       // create the mapping
       for (j = 0; j < files.length; j++) {
         file = files[j];
-        if (file in fileMap)
+        if (file in fileMap && fileMap[file].indexOf(word) === -1)
           fileMap[file].push(word);
         else
           fileMap[file] = [word];