Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ShawnDriscoll committed Nov 20, 2018
1 parent c45515c commit e0eba88
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
Binary file modified docs/build/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/.doctrees/introduction.doctree
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/build/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h2>Installing Automatically<a class="headerlink" href="#installing-automaticall
<img alt="_images/egg.png" src="_images/egg.png" />
</div>
<p><em>New in version 2.3</em></p>
<p>Extract <tt class="docutils literal"><span class="pre">diceroll_2.4.1b.zip</span></tt> and start a CMD window at the folder location of the <tt class="docutils literal"><span class="pre">setup.py</span></tt> file. At the
<p>Extract <tt class="docutils literal"><span class="pre">diceroll_2.4.2b.zip</span></tt> and start a CMD window at the folder location of the <tt class="docutils literal"><span class="pre">setup.py</span></tt> file. At the
CMD prompt you can type:</p>
<pre>setup.py install</pre>
<p>or:</p>
Expand All @@ -148,15 +148,15 @@ <h2>Installing Automatically<a class="headerlink" href="#installing-automaticall
<p class="first admonition-title">Note</p>
<p class="last">During the installation process,
a <tt class="docutils literal"><span class="pre">Python25\Lib\site-packages\game_utils</span></tt> folder will be created. It will contain <tt class="docutils literal"><span class="pre">__init__.py</span></tt> and <tt class="docutils literal"><span class="pre">diceroll.py</span></tt> if your Python
doesn't have <tt class="docutils literal"><span class="pre">setuptools</span></tt> installed. Otherwise, an .egg file called <tt class="docutils literal"><span class="pre">diceroll-2.4.1b-py2.5.egg</span></tt> will be
doesn't have <tt class="docutils literal"><span class="pre">setuptools</span></tt> installed. Otherwise, an .egg file called <tt class="docutils literal"><span class="pre">diceroll-2.4.2b-py2.5.egg</span></tt> will be
created and copied into the <tt class="docutils literal"><span class="pre">Python25\Lib\site-packages</span></tt> folder.</p>
</div>
<p>No matter the automated installation that your Python performed, importing will be the same:</p>
<div class="highlight"><pre><span class="kn">from</span> <span class="nn">game_utils.diceroll</span> <span class="kn">import</span> <span class="n">roll</span>
</pre></div>
<p>Some ways to see if the <tt class="docutils literal"><span class="pre">diceroll</span></tt> module was installed correctly is by typing:</p>
<div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">roll</span><span class="p">(</span><span class="s">&#39;info&#39;</span><span class="p">)</span>
<span class="go">(&#39;2.4&#39;, &#39;roll(), release version 2.4.1b for Classic Python 2.5.4&#39;)</span>
<span class="go">(&#39;2.4&#39;, &#39;roll(), release version 2.4.2b for Classic Python 2.5.4&#39;)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">print</span> <span class="n">roll</span><span class="o">.</span><span class="n">__doc__</span>
<span class="go"> The dice types to roll are:</span>
<span class="go"> &#39;D2&#39;, &#39;D3&#39;, &#39;D4&#39;, &#39;D6&#39;, &#39;D8&#39;, &#39;D9&#39;, &#39;D10&#39;,</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="diceroll 2.4 Operations Manual" href="index.html" />
<generator object at 0x03592F08>
<generator object at 0x035B4030>

<script type="text/javascript">
DOCUMENTATION_OPTIONS.COLLAPSE_MODINDEX = true;
Expand Down
2 changes: 1 addition & 1 deletion docs/build/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<link rel="index" title="Global index" href="genindex.html" />
<link rel="search" title="Search" href="" />
<link rel="top" title="diceroll 2.4 Operations Manual" href="index.html" />
<generator object at 0x039736C0>
<generator object at 0x036075A8>
<script type="text/javascript" src="_static/searchtools.js"></script>

</head>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/searchindex.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/source/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Installing Automatically

*New in version 2.3*

Extract ``diceroll_2.4.1b.zip`` and start a CMD window at the folder location of the ``setup.py`` file. At the
Extract ``diceroll_2.4.2b.zip`` and start a CMD window at the folder location of the ``setup.py`` file. At the
CMD prompt you can type: ::

setup.py install
Expand All @@ -109,7 +109,7 @@ depending on if your computer knows how to open .py files or not.

During the installation process,
a ``Python25\Lib\site-packages\game_utils`` folder will be created. It will contain ``__init__.py`` and ``diceroll.py`` if your Python
doesn't have ``setuptools`` installed. Otherwise, an .egg file called ``diceroll-2.4.1b-py2.5.egg`` will be
doesn't have ``setuptools`` installed. Otherwise, an .egg file called ``diceroll-2.4.2b-py2.5.egg`` will be
created and copied into the ``Python25\Lib\site-packages`` folder.

No matter the automated installation that your Python performed, importing will be the same: ::
Expand All @@ -119,7 +119,7 @@ No matter the automated installation that your Python performed, importing will
Some ways to see if the ``diceroll`` module was installed correctly is by typing:

>>> print roll('info')
('2.4', 'roll(), release version 2.4.1b for Classic Python 2.5.4')
('2.4', 'roll(), release version 2.4.2b for Classic Python 2.5.4')
>>> print roll.__doc__
The dice types to roll are:
'D2', 'D3', 'D4', 'D6', 'D8', 'D9', 'D10',
Expand Down

0 comments on commit e0eba88

Please sign in to comment.