Added documentation for the dice classes

Author: Bernardo-MG

dice_notation/dice.py

@@ -65,7 +65,6 @@ class Dice(object):
     which a die may physically have are limited by the rules of geometry,
     but there is no reason to take care of that.
     """
-    __metaclass__ = ABCMeta
 
     def __init__(self, quantity, sides):
         super(Dice, self).__init__()

docs/source/_static/diagram/dice_class_diagram.png

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<diagram program="umlet" version="14.2">
+  <zoom_level>10</zoom_level>
+  <element>
+    <id>UMLClass</id>
+    <coordinates>
+      <x>310</x>
+      <y>210</y>
+      <w>100</w>
+      <h>70</h>
+    </coordinates>
+    <panel_attributes>bg=orange
+/Rollable/
+--
+
+--
+/+roll()/</panel_attributes>
+    <additional_attributes/>
+  </element>
+  <element>
+    <id>UMLClass</id>
+    <coordinates>
+      <x>470</x>
+      <y>210</y>
+      <w>100</w>
+      <h>70</h>
+    </coordinates>
+    <panel_attributes>bg=yellow
+Dice
+--
++quantity: int
++sides: int
+--</panel_attributes>
+    <additional_attributes/>
+  </element>
+  <element>
+    <id>UMLClass</id>
+    <coordinates>
+      <x>390</x>
+      <y>360</y>
+      <w>100</w>
+      <h>70</h>
+    </coordinates>
+    <panel_attributes>bg=yellow
+RollableDice
+--
+
+--</panel_attributes>
+    <additional_attributes/>
+  </element>
+  <element>
+    <id>Relation</id>
+    <coordinates>
+      <x>350</x>
+      <y>270</y>
+      <w>110</w>
+      <h>110</h>
+    </coordinates>
+    <panel_attributes>lt=&lt;&lt;-</panel_attributes>
+    <additional_attributes>10.0;10.0;10.0;50.0;90.0;50.0;90.0;90.0</additional_attributes>
+  </element>
+  <element>
+    <id>Relation</id>
+    <coordinates>
+      <x>430</x>
+      <y>270</y>
+      <w>110</w>
+      <h>70</h>
+    </coordinates>
+    <panel_attributes>lt=&lt;&lt;-</panel_attributes>
+    <additional_attributes>90.0;10.0;90.0;50.0;10.0;50.0</additional_attributes>
+  </element>
+</diagram>

docs/source/_static/diagram/dice_class_diagram.uxf

@@ -115,7 +115,8 @@
     'general_info_links': [('Acquire', './acquire.html'),
                            ('Usage', './usage.html')],
     'navbar_links': [('Documentation', [('Acquire', './acquire.html'),
-                                        ('Usage', './usage.html')]),
+                                        ('Usage', './usage.html'),
+                                        ('Dice model', './docs/dice.html')]),
                      ('Info and Reports', [('Reports', './reports.html'),
                                            ('Code docs', './code/index.html')])],
 }

docs/source/conf.py

@@ -0,0 +1,14 @@
+==========
+Dice model
+==========
+
+.. image:: ../_static/diagram/dice_class_diagram.png
+	:alt: Dice class diagram
+
+While the Dice class represents a dice group, it is the RollableDice the actual
+class which will be used by the parser, as it allows generating random values
+through the use of the roll() method.
+
+The Rollable abstract class is actually used to extend to add compatibility
+between the dice and other classes, and will be used by the parser nodes to
+allow rolling any parsed dice notation expression.

docs/source/docs/dice.rst

@@ -23,5 +23,5 @@ Features
    acquire
    usage
    reports
-   code/dice
    code/index
+   docs/dice