test documentation

ShawnDriscoll · Sep 30, 2017 · f49050e · f49050e
1 parent 83529ca
commit f49050e
Show file tree

Hide file tree

Showing 34 changed files with 3,775 additions and 0 deletions.
diff --git a/docs/.doctrees/diceroll.doctree b/docs/.doctrees/diceroll.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/project.doctree b/docs/.doctrees/project.doctree
diff --git a/docs/.doctrees/tutorial.doctree b/docs/.doctrees/tutorial.doctree
diff --git a/docs/_sources/diceroll.txt b/docs/_sources/diceroll.txt
@@ -0,0 +1,5 @@
+diceroll module
+===============
+
+.. automodule:: diceroll
+   :members:
diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt
@@ -0,0 +1,29 @@
+.. diceroll documentation master file, created by sphinx-quickstart on Sat Sep 30 08:31:05 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to diceroll's documentation!
+======================================
+
+This is my introduction to this project.
+
+Requirements:
+
+My project depends on Python 2.5.4.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   tutorial
+   project
+   diceroll
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/_sources/project.txt b/docs/_sources/project.txt
@@ -0,0 +1,16 @@
+Project Summary
+===============
+
+Goals Achieved
+--------------
+Goal 1 = This is the title of my first goal.
+
+This is a description of what I managed to complete on this goal.
+
+Goal 2 = This is the title of my second goal.
+
+This is the description of what I managed to complete on this goal.
+
+Lessons Learned
+---------------
+This is a paragraph describing what I learned from this project.
diff --git a/docs/_sources/tutorial.txt b/docs/_sources/tutorial.txt
@@ -0,0 +1,8 @@
+diceroll Tutorial
+===================
+
+This is a short description about how to use diceroll: ::
+
+    from dicerull import roll
+
+
diff --git a/docs/_static/contents.png b/docs/_static/contents.png