Skip to content

Commit

Permalink
web pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ShawnDriscoll committed Sep 30, 2017
1 parent 27ab54c commit 25d3cfd
Show file tree
Hide file tree
Showing 34 changed files with 3,775 additions and 0 deletions.
Binary file added .doctrees/diceroll.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/project.doctree
Binary file not shown.
Binary file added .doctrees/tutorial.doctree
Binary file not shown.
128 changes: 128 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to diceroll&#8217;s documentation! &mdash; diceroll v2.2.1b documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.2.1b',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/diceroll_icon_16x16.ico"/>
<link rel="contents" title="Global table of contents" href="contents.html" />
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="diceroll v2.2.1b documentation" href="" />
<link rel="next" title="diceroll Tutorial" href="tutorial.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="diceroll Tutorial"
accesskey="N">next</a> |</li>
<li><a href="">diceroll v2.2.1b documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">

<div class="section" id="welcome-to-diceroll-s-documentation">
<h1>Welcome to diceroll&#8217;s documentation!<a class="headerlink" href="#welcome-to-diceroll-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>This is my introduction to this project.</p>
<p>Requirements:</p>
<p>My project depends on Python 2.5.4.</p>
<p>Contents:</p>
<ul>
<li><a class="reference external" href="tutorial.html">diceroll Tutorial</a></li>
</ul>
<ul>
<li><a class="reference external" href="project.html">Project Summary</a><ul>
<li><a class="reference external" href="project.html#goals-achieved">Goals Achieved</a></li>
<li><a class="reference external" href="project.html#lessons-learned">Lessons Learned</a></li>
</ul>
</li>
</ul>
<ul>
<li><a class="reference external" href="diceroll.html">diceroll module</a></li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference external" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li>
<li><a class="reference external" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<p class="logo"><img class="logo" src="_static/diceroll.png" alt="Logo"/></p>
<h3>Table Of Contents</h3>
<ul>
<li><a class="reference external" href="">Welcome to diceroll&#8217;s documentation!</a><ul>
</ul>
</li>
<li><a class="reference external" href="#indices-and-tables">Indices and tables</a></li>
</ul>

<h4>Next topic</h4>
<p class="topless"><a href="tutorial.html" title="next chapter">diceroll Tutorial</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt">Show Source</a></li>
</ul>
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" /> <input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="modindex.html" title="Global Module Index"
accesskey="M">modules</a> |</li>
<li class="right" >
<a href="tutorial.html" title="diceroll Tutorial"
accesskey="N">next</a> |</li>
<li><a href="">diceroll v2.2.1b documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2017, Shawn Driscoll.
Last updated on Sep 30, 2017.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
</div>
</body>
</html>
5 changes: 5 additions & 0 deletions _sources/diceroll.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
diceroll module
===============

.. automodule:: diceroll
:members:
29 changes: 29 additions & 0 deletions _sources/index.txt
Original file line number Diff line number Diff line change
@@ -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`

16 changes: 16 additions & 0 deletions _sources/project.txt
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 8 additions & 0 deletions _sources/tutorial.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
diceroll Tutorial
===================

This is a short description about how to use diceroll: ::

from dicerull import roll


Binary file added _static/contents.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 25d3cfd

Please sign in to comment.