docs: updated docs

tasdikrahman · Apr 12, 2016 · 526ab81 · 526ab81
1 parent 5fd3646
commit 526ab81
Show file tree

Hide file tree

Showing 12 changed files with 186 additions and 333 deletions.
diff --git a/README.rst b/README.rst
@@ -4,7 +4,7 @@ spammy
 |Pypi version| |Build Status| |percentagecov| |Requirements Status| |License| 
 
 :Author: `Tasdik Rahman <http://tasdikrahman.me>`__
-:Latest version: 1.0.0
+:Latest version: 1.0.2
 
 .. contents::
     :backlinks: none
@@ -17,6 +17,9 @@ Overview
 
 `spammy <https://github.com/prodicus/spammy>`__ : Spam filtering at your service
 
+.. figure:: http://i.imgur.com/L8moQ2U.jpg
+    :alt:
+
 Features
 --------
 
@@ -92,7 +95,7 @@ Example
     0.9033333333333333
     >>> 
 
-**More examples can be found over in the `examples directory <https://github.com/prodicus/spammy/tree/master/examples>`__ **
+**NOTE**: More examples can be found over in the `examples directory <https://github.com/prodicus/spammy/tree/master/examples>`__
 
 Installation
 ------------
@@ -101,6 +104,8 @@ Installation
 .. figure:: http://hd.wallpaperswide.com/thumbs/shut_up_and_take_my_money-t2.jpg
     :alt:
 
+**NOTE**: Currently supports only ``python2``
+
 **Install the dependencies first**
 
 .. code:: bash
@@ -201,6 +206,7 @@ Roadmap
 ~~~~~~~
 
 - Include more algorithms for increased accuracy
+- python3 support
 
 Licensing
 ---------

diff --git a/docs/_build/doctrees/api_reference.doctree b/docs/_build/doctrees/api_reference.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/spammy.doctree b/docs/_build/doctrees/spammy.doctree
diff --git a/docs/_build/singlehtml/index.html b/docs/_build/singlehtml/index.html
@@ -6,15 +6,15 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
-    <title>spammy documentation</title>
+    <title>Spammy 1.0.2 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:     '',
+        VERSION:     '1.0.2',
         COLLAPSE_INDEX: false,
         FILE_SUFFIX: '.html',
         HAS_SOURCE:  true
@@ -29,7 +29,7 @@
     <div class="related">
       <h3>Navigation</h3>
       <ul>
-        <li><a href="index.html#document-index">spammy  documentation</a> &raquo;</li> 
+        <li><a href="index.html#document-index">Spammy 1.0.2 documentation</a> &raquo;</li> 
       </ul>
     </div>  
 
@@ -38,19 +38,7 @@ <h3>Navigation</h3>
         <div class="bodywrapper">
           <div class="body">
 
-  <div class="section" id="spammy">
-<h1>1&nbsp;&nbsp;&nbsp;spammy<a class="headerlink" href="#spammy" title="Permalink to this headline">¶</a></h1>
-<p><a class="reference external" href="https://pypi.python.org/pypi/spammy"><img alt="PyPI version" src="https://img.shields.io/pypi/v/spammy.svg" /></a> <a class="reference external" href="https://travis-ci.org/prodicus/spammy"><img alt="Build Status" src="https://travis-ci.org/prodicus/spammy.svg?branch=master" /></a> <a class="reference external" href="https://www.codacy.com/app/tasdik95/spammy"><img alt="percentagecov" src="https://api.codacy.com/project/badge/coverage/e2cb32eae16242f795f498d40d0d8984" /></a> <a class="reference external" href="https://requires.io/github/prodicus/spammy/requirements/?branch=master"><img alt="Requirements Status" src="https://requires.io/github/prodicus/spammy/requirements.svg?branch=master" /></a> <a class="reference external" href="https://pypi.python.org/pypi/spammys"><img alt="License" src="https://img.shields.io/pypi/l/spammy.svg" /></a></p>
-<table class="docutils field-list" frame="void" rules="none">
-<col class="field-name" />
-<col class="field-body" />
-<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body"><a class="reference external" href="http://tasdikrahman.me">Tasdik Rahman</a></td>
-</tr>
-<tr class="field-even field"><th class="field-name">Latest version:</th><td class="field-body">1.0.0</td>
-</tr>
-</tbody>
-</table>
+  <p><a class="reference external" href="https://pypi.python.org/pypi/spammy"><img alt="PyPI version" src="https://img.shields.io/pypi/v/spammy.svg" /></a> <a class="reference external" href="https://travis-ci.org/prodicus/spammy"><img alt="Build Status" src="https://travis-ci.org/prodicus/spammy.svg?branch=master" /></a> <a class="reference external" href="https://www.codacy.com/app/tasdik95/spammy"><img alt="percentagecov" src="https://api.codacy.com/project/badge/coverage/e2cb32eae16242f795f498d40d0d8984" /></a> <a class="reference external" href="https://requires.io/github/prodicus/spammy/requirements/?branch=master"><img alt="Requirements Status" src="https://requires.io/github/prodicus/spammy/requirements.svg?branch=master" /></a> <a class="reference external" href="https://pypi.python.org/pypi/spammys"><img alt="License" src="https://img.shields.io/pypi/l/spammy.svg" /></a></p>
 <div class="contents topic" id="contents">
 <p class="topic-title first">Contents</p>
 <ul class="auto-toc simple">
@@ -76,6 +64,18 @@ <h1>1&nbsp;&nbsp;&nbsp;spammy<a class="headerlink" href="#spammy" title="Permali
 <li><a class="reference internal" href="#indices-and-tables" id="id16">3&nbsp;&nbsp;&nbsp;Indices and tables</a></li>
 </ul>
 </div>
+<div class="section" id="spammy">
+<h1>1&nbsp;&nbsp;&nbsp;spammy<a class="headerlink" href="#spammy" title="Permalink to this headline">¶</a></h1>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Author:</th><td class="field-body"><a class="reference external" href="http://tasdikrahman.me">Tasdik Rahman</a></td>
+</tr>
+<tr class="field-even field"><th class="field-name">Latest version:</th><td class="field-body">1.0.0</td>
+</tr>
+</tbody>
+</table>
 <div class="section" id="overview">
 <h2>1.1&nbsp;&nbsp;&nbsp;Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>
 <p><a class="reference external" href="https://github.com/prodicus/spammy">spammy</a> : Spam filtering at your service</p>
@@ -273,10 +273,10 @@ <h2>1.8&nbsp;&nbsp;&nbsp;Credits<a class="headerlink" href="#credits" title="Per
 <div class="section" id="documentation">
 <h1>2&nbsp;&nbsp;&nbsp;Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
-<span id="document-spammy"></span><div class="section" id="spammy-package">
-<h2>spammy package<a class="headerlink" href="#spammy-package" title="Permalink to this headline">¶</a></h2>
-<div class="section" id="submodules">
-<h3>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h3>
+<span id="document-api_reference"></span><div class="section" id="api-reference">
+<span id="api"></span><h2>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="spammy-classes">
+<h3>Spammy Classes<a class="headerlink" href="#spammy-classes" title="Permalink to this headline">¶</a></h3>
 </div>
 <div class="section" id="module-spammy.classifier">
 <span id="spammy-classifier-module"></span><h3>spammy.classifier module<a class="headerlink" href="#module-spammy.classifier" title="Permalink to this headline">¶</a></h3>
@@ -329,8 +329,8 @@ <h4>References<a class="headerlink" href="#references" title="Permalink to this
 <dl class="method">
 <dt id="spammy.classifier.NaiveBayesClassifier.document_probability">
 <tt class="descname">document_probability</tt><big>(</big><em>features</em>, <em>label</em><big>)</big><a class="reference internal" href="_modules/spammy/classifier.html#NaiveBayesClassifier.document_probability"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#spammy.classifier.NaiveBayesClassifier.document_probability" title="Permalink to this definition">¶</a></dt>
-<dd><p>Finds <cite>document_probability()</cite> by looping over the documents and
-calling <cite>feature_probability()</cite></p>
+<dd><p>Finds <a class="reference internal" href="index.html#spammy.classifier.NaiveBayesClassifier.document_probability" title="spammy.classifier.NaiveBayesClassifier.document_probability"><tt class="xref py py-obj docutils literal"><span class="pre">document_probability()</span></tt></a> by looping over the documents and
+calling <a class="reference internal" href="index.html#spammy.classifier.NaiveBayesClassifier.feature_probability" title="spammy.classifier.NaiveBayesClassifier.feature_probability"><tt class="xref py py-obj docutils literal"><span class="pre">feature_probability()</span></tt></a></p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
@@ -392,11 +392,11 @@ <h4>References<a class="headerlink" href="#references" title="Permalink to this
 its nltk.NaiveBayesClassifier.train() gives</p>
 <div class="admonition note">
 <p class="first admonition-title">Note</p>
-<p><cite>defaultdict</cite> is used bacause when we try to acces a key which is not
-there in the <cite>dictionary</cite>, we get a <cite>KeyError</cite>. Whereas in
-<cite>defaultdict</cite>.It will try to return a default value if the key is not
+<p><tt class="xref py py-obj docutils literal"><span class="pre">defaultdict</span></tt> is used bacause when we try to acces a key which is not
+there in the <tt class="xref py py-obj docutils literal"><span class="pre">dictionary</span></tt>, we get a <tt class="xref py py-obj docutils literal"><span class="pre">KeyError</span></tt>. Whereas in
+<tt class="xref py py-obj docutils literal"><span class="pre">defaultdict</span></tt>.It will try to return a default value if the key is not
 found.</p>
-<p class="last">For more on <cite>defaultdict</cite>,
+<p class="last">For more on <tt class="xref py py-obj docutils literal"><span class="pre">defaultdict</span></tt>,
 Refer: <a class="reference external" href="http://stackoverflow.com/a/5900634/3834059">http://stackoverflow.com/a/5900634/3834059</a></p>
 </div>
 <table class="docutils field-list" frame="void" rules="none">
@@ -666,35 +666,39 @@ <h1>3&nbsp;&nbsp;&nbsp;Indices and tables<a class="headerlink" href="#indices-an
         </div>
       </div>
       <div class="sphinxsidebar">
-        <div class="sphinxsidebarwrapper">
-  <h3><a href="index.html#document-index">Table Of Contents</a></h3>
-  <ul>
-<li class="toctree-l1"><a class="reference internal" href="index.html#document-spammy">spammy package</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="index.html#submodules">Submodules</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#module-spammy.classifier">spammy.classifier module</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="index.html#references">References</a></li>
-</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#module-spammy.exceptions">spammy.exceptions module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#module-spammy.train">spammy.train module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#module-spammy.version">spammy.version module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#module-spammy">Module contents</a></li>
-</ul>
-</li>
+        <div class="sphinxsidebarwrapper"><p>
+  <iframe src="https://ghbtns.com/github-btn.html?user=prodicus&repo=spammy&type=watch&count=true&size=large"
+    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+
+<p>
+Spammy: Spam filtering made easy for you
+</p>
+
+
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://pypi.python.org/pypi/spammy">spammy @ PyPI</a></li>
+  <li><a href="https://github.com/prodicus/spammy">spammy @ GitHub</a></li>
+  <li><a href="https://github.com/prodicus/spammy/issues">Issue Tracker</a></li>
 </ul>
 
+<h3>Stay Informed</h3>
+
+<p><iframe src="https://ghbtns.com/github-btn.html?user=prodicus&type=follow"
+  allowtransparency="true" frameborder="0" scrolling="0" width="165" height="20"></iframe></p>
         </div>
       </div>
       <div class="clearer"></div>
     </div>
     <div class="related">
       <h3>Navigation</h3>
       <ul>
-        <li><a href="index.html#document-index">spammy  documentation</a> &raquo;</li> 
+        <li><a href="index.html#document-index">Spammy 1.0.2 documentation</a> &raquo;</li> 
       </ul>
     </div>
     <div class="footer">
-        &copy; Copyright 2016, Tasdik Rahman (@tasdikrahman).
+        &copy; Copyright 2016 &lt;a href=&#34;http://tasdikrahman.me/&#34;&gt;Tasdik Rahman&lt;/a&gt;.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
     </div>
   </body>

diff --git a/docs/_build/singlehtml/objects.inv b/docs/_build/singlehtml/objects.inv
diff --git a/docs/_templates/side-primary.html b/docs/_templates/side-primary.html
@@ -0,0 +1,21 @@
+<p>
+  <iframe src="https://ghbtns.com/github-btn.html?user=prodicus&repo=spammy&type=watch&count=true&size=large"
+    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+
+<p>
+Spammy: Spam filtering made easy for you
+</p>
+
+
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://pypi.python.org/pypi/spammy">spammy @ PyPI</a></li>
+  <li><a href="https://github.com/prodicus/spammy">spammy @ GitHub</a></li>
+  <li><a href="https://github.com/prodicus/spammy/issues">Issue Tracker</a></li>
+</ul>
+
+<h3>Stay Informed</h3>
+
+<p><iframe src="https://ghbtns.com/github-btn.html?user=prodicus&type=follow"
+  allowtransparency="true" frameborder="0" scrolling="0" width="165" height="20"></iframe></p>
diff --git a/docs/_templates/side-secondary.html b/docs/_templates/side-secondary.html
@@ -0,0 +1,17 @@
+<p>
+  <iframe src="https://ghbtns.com/github-btn.html?user=prodicus&repo=spammy&type=watch&count=true&size=large"
+    allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
+</p>
+
+
+<p>
+Spammy: Spam filtering made easy for you
+</p>
+
+
+<h3>Useful Links</h3>
+<ul>
+  <li><a href="https://pypi.python.org/pypi/spammy">spammy @ PyPI</a></li>
+  <li><a href="https://github.com/prodicus/spammy">spammy @ GitHub</a></li>
+  <li><a href="https://github.com/prodicus/textblob/issues">Issue Tracker</a></li>
+</ul>
diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -0,0 +1,48 @@
+.. _api:
+
+API Reference
+=============
+
+Spammy Classes
+--------------
+
+spammy.classifier module
+------------------------
+
+.. automodule:: spammy.classifier
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+spammy.exceptions module
+------------------------
+
+.. automodule:: spammy.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+spammy.train module
+-------------------
+
+.. automodule:: spammy.train
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+spammy.version module
+---------------------
+
+.. automodule:: spammy.version
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: spammy
+    :members:
+    :undoc-members:
+    :show-inheritance: