Update sphinx docs

docs/_build/html/_sources/api.txt

@@ -11,11 +11,13 @@ hashes
    :members:
 
 
+
 key
 =========================
 
 .. automodule:: simplecrypto.key
    :members:
+   :show-inheritance:
 
 
 formats

docs/_build/html/_sources/index.txt

@@ -12,7 +12,7 @@ Includes functions for hashes, symmetric and asymmetric crypto, along with helpe
 functions. Acts as a wrapper for ``PyCrypto`` and a few standard libraries.
 
 Installation
-------------
+============
 
 ::
 
@@ -24,14 +24,17 @@ use a `prebuilt installer <http://www.voidspace.org.uk/python/modules.shtml#pycr
 
 
 API Documentation
------------------
+=================
 
 .. toctree::
    :maxdepth: 2
 
    api
 
 
+Examples
+========
+
 Hashes
 ------
 

docs/_build/html/api.html

@@ -91,13 +91,15 @@ <h3>Navigation</h3>
 <dl class="class">
 <dt id="simplecrypto.key.AesKey">
 <em class="property">class </em><tt class="descclassname">simplecrypto.key.</tt><tt class="descname">AesKey</tt><big>(</big><em>key=None</em><big>)</big><a class="reference internal" href="_modules/simplecrypto/key.html#AesKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#simplecrypto.key.AesKey" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class for symmetric AES with 256 bits block size.</p>
+<dd><p>Bases: <a class="reference internal" href="#simplecrypto.key.Key" title="simplecrypto.key.Key"><tt class="xref py py-class docutils literal"><span class="pre">simplecrypto.key.Key</span></tt></a></p>
+<p>Class for symmetric AES with 256 bits block size.</p>
 </dd></dl>
 
 <dl class="class">
 <dt id="simplecrypto.key.Key">
 <em class="property">class </em><tt class="descclassname">simplecrypto.key.</tt><tt class="descname">Key</tt><big>(</big><em>algorithm_name</em>, <em>nbits=None</em>, <em>block_size=None</em><big>)</big><a class="reference internal" href="_modules/simplecrypto/key.html#Key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#simplecrypto.key.Key" title="Permalink to this definition">¶</a></dt>
-<dd><p>Abstract base class for all keys, symmetric or not, public or not.</p>
+<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">builtins.object</span></tt></p>
+<p>Abstract base class for all keys, symmetric or not, public or not.</p>
 <p>Subclasses should implement <cite>encrypt_raw</cite>, <cite>decrypt_raw</cite> and <cite>serialize</cite>
 as necessary.</p>
 <dl class="method">
@@ -139,13 +141,15 @@ <h3>Navigation</h3>
 <dl class="class">
 <dt id="simplecrypto.key.RsaKeypair">
 <em class="property">class </em><tt class="descclassname">simplecrypto.key.</tt><tt class="descname">RsaKeypair</tt><big>(</big><em>source=2048</em><big>)</big><a class="reference internal" href="_modules/simplecrypto/key.html#RsaKeypair"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#simplecrypto.key.RsaKeypair" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class for asymmetric RSA keypair.</p>
+<dd><p>Bases: <a class="reference internal" href="#simplecrypto.key.Key" title="simplecrypto.key.Key"><tt class="xref py py-class docutils literal"><span class="pre">simplecrypto.key.Key</span></tt></a></p>
+<p>Class for asymmetric RSA keypair.</p>
 </dd></dl>
 
 <dl class="class">
 <dt id="simplecrypto.key.RsaPublicKey">
 <em class="property">class </em><tt class="descclassname">simplecrypto.key.</tt><tt class="descname">RsaPublicKey</tt><big>(</big><em>key</em><big>)</big><a class="reference internal" href="_modules/simplecrypto/key.html#RsaPublicKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#simplecrypto.key.RsaPublicKey" title="Permalink to this definition">¶</a></dt>
-<dd><p>Class for asymmetric public RSA key.</p>
+<dd><p>Bases: <a class="reference internal" href="#simplecrypto.key.Key" title="simplecrypto.key.Key"><tt class="xref py py-class docutils literal"><span class="pre">simplecrypto.key.Key</span></tt></a></p>
+<p>Class for asymmetric public RSA key.</p>
 </dd></dl>
 
 <dl class="function">

docs/_build/html/index.html

@@ -53,16 +53,17 @@ <h1>Welcome to simplecrypto&#8217;s documentation!<a class="headerlink" href="#w
 <p>Cryptographic library with really simple API.</p>
 <p>Includes functions for hashes, symmetric and asymmetric crypto, along with helper
 functions. Acts as a wrapper for <tt class="docutils literal"><span class="pre">PyCrypto</span></tt> and a few standard libraries.</p>
+</div>
 <div class="section" id="installation">
-<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
+<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1>
 <div class="highlight-python"><pre>pip install simplecrypto</pre>
 </div>
 <p>This library depends on <tt class="docutils literal"><span class="pre">PyCrypto</span></tt>. On Linux this is installed automatically by
 pip. If the dependency installation fail on Windows, you may want to
 use a <a class="reference external" href="http://www.voidspace.org.uk/python/modules.shtml#pycrypto">prebuilt installer</a>.</p>
 </div>
 <div class="section" id="api-documentation">
-<h2>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h2>
+<h1>API Documentation<a class="headerlink" href="#api-documentation" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a><ul>
@@ -77,6 +78,8 @@ <h2>API Documentation<a class="headerlink" href="#api-documentation" title="Perm
 </ul>
 </div>
 </div>
+<div class="section" id="examples">
+<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="hashes">
 <h2>Hashes<a class="headerlink" href="#hashes" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">simplecrypto</span> <span class="kn">import</span> <span class="n">md5</span><span class="p">,</span> <span class="n">sha1</span><span class="p">,</span> <span class="nb">hash</span>
@@ -214,11 +217,12 @@ <h2>And miscellaneous helpers<a class="headerlink" href="#and-miscellaneous-help
         <div class="sphinxsidebarwrapper">
   <h3><a href="#">Table Of Contents</a></h3>
   <ul>
-<li><a class="reference internal" href="#">Welcome to simplecrypto&#8217;s documentation!</a><ul>
+<li><a class="reference internal" href="#">Welcome to simplecrypto&#8217;s documentation!</a></li>
 <li><a class="reference internal" href="#installation">Installation</a></li>
 <li><a class="reference internal" href="#api-documentation">API Documentation</a><ul>
 </ul>
 </li>
+<li><a class="reference internal" href="#examples">Examples</a><ul>
 <li><a class="reference internal" href="#hashes">Hashes</a></li>
 <li><a class="reference internal" href="#symmetric-crypto">Symmetric crypto</a></li>
 <li><a class="reference internal" href="#asymmetric-crypto">Asymmetric crypto</a></li>

docs/api.rst

@@ -11,11 +11,13 @@ hashes
    :members:
 
 
+
 key
 =========================
 
 .. automodule:: simplecrypto.key
    :members:
+   :show-inheritance:
 
 
 formats

docs/index.rst

@@ -12,7 +12,7 @@ Includes functions for hashes, symmetric and asymmetric crypto, along with helpe
 functions. Acts as a wrapper for ``PyCrypto`` and a few standard libraries.
 
 Installation
-------------
+============
 
 ::
 
@@ -24,14 +24,17 @@ use a `prebuilt installer <http://www.voidspace.org.uk/python/modules.shtml#pycr
 
 
 API Documentation
------------------
+=================
 
 .. toctree::
    :maxdepth: 2
 
    api
 
 
+Examples
+========
+
 Hashes
 ------