Still working out the docs.

This commit is contained in:
Elf M. Sternberg 2016-09-01 10:55:16 -07:00
parent 7e811c0387
commit 6506acd861
35 changed files with 360 additions and 810 deletions

View File

@ -63,12 +63,15 @@ coverage:
$(BROWSER) htmlcov/index.html
docs:
rm -f docs/polyloader.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ polyloader
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
rm -f docs/src/polyloader.rst
rm -f docs/src/modules.rst
sphinx-apidoc -o docs/src polyloader
$(MAKE) -C docs/src clean
$(MAKE) -C docs/src html
mv docs/_static/* docs/
rm -fr docs/_static
perl -pi.bak -e 's/_static\///g' docs/*.html
rm docs/*.html.bak
servedocs: docs
watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .

View File

@ -1,4 +1,3 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -7,33 +6,36 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; polyloader 0.1.0 documentation</title>
<title>Overview: module code &mdash; polyloader 0.1.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<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: './',
URL_ROOT: '../',
VERSION: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -42,25 +44,18 @@
<div class="bodywrapper">
<div class="body">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
</div>
<h1>All modules for which code is available</h1>
<ul><li><a href="polyloader.html">polyloader</a></li>
</ul>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
@ -79,9 +74,12 @@
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
<a href="../genindex.html" title="General Index"
>index</a></li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">

View File

@ -0,0 +1,106 @@
<!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>polyloader &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="../index.html" />
<link rel="up" title="Module code" href="index.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="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Module code</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for polyloader</h1><div class="highlight"><pre>
<span class="c"># -*- coding: utf-8 -*-</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s">&#39;Kenneth M. &quot;Elf&quot; Sternberg&#39;</span>
<span class="n">__email__</span> <span class="o">=</span> <span class="s">&#39;elf.sternberg@gmail.com&#39;</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">&#39;0.1.0&#39;</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="mi">6</span><span class="p">):</span>
<span class="kn">from</span> <span class="nn">._python2</span> <span class="kn">import</span> <span class="n">install</span><span class="p">,</span> <span class="n">reset</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="mi">3</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">._python3</span> <span class="kn">import</span> <span class="n">install</span><span class="p">,</span> <span class="n">reset</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;install&#39;</span><span class="p">,</span> <span class="s">&#39;reset&#39;</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
<li><a href="index.html" >Module code</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -0,0 +1,7 @@
polyloader
==========
.. toctree::
:maxdepth: 4
polyloader

View File

@ -0,0 +1,10 @@
polyloader package
==================
Module contents
---------------
.. automodule:: polyloader
:members:
:undoc-members:
:show-inheritance:

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
@ -90,6 +93,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
>next</a> |</li>

View File

@ -1,107 +0,0 @@
<!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>&lt;no title&gt; &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="&lt;no title&gt;" href="history.html" />
<link rel="prev" title="&lt;no title&gt;" href="contributing.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="history.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="contributing.html"
title="previous chapter">&lt;no title&gt;</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="history.html"
title="next chapter">&lt;no title&gt;</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/authors.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
>next</a> |</li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
>previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
@ -90,6 +93,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
>next</a> |</li>

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -33,6 +33,9 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -46,8 +49,41 @@
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#I"><strong>I</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#R"><strong>R</strong></a>
</div>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="polyloader.html#polyloader.install">install() (in module polyloader)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="polyloader.html#module-polyloader">polyloader (module)</a>
</dt>
</dl></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="polyloader.html#polyloader.reset">reset() (in module polyloader)</a>
</dt>
</dl></td>
</tr></table>
</div>
@ -81,6 +117,9 @@
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="todo.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
@ -90,6 +93,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="todo.html" title="&lt;no title&gt;"
>next</a> |</li>

View File

@ -33,6 +33,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="readme.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
@ -111,6 +114,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="readme.html" title="&lt;no title&gt;"
>next</a> |</li>

View File

@ -1,125 +0,0 @@
<!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 py-polymorphic-loaders documentation! &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="#" />
<link rel="next" title="&lt;no title&gt;" href="readme.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="readme.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li><a href="#">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-py-polymorphic-loader-s-documentation">
<h1>Welcome to py-polymorphic-loader&#8217;s documentation!<a class="headerlink" href="#welcome-to-py-polymorphic-loader-s-documentation" title="Permalink to this headline"></a></h1>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#stable-release">Stable release</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#from-sources">From sources</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
</ul>
</div>
</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 internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to py-polymorphic-loader&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="readme.html"
title="next chapter">&lt;no title&gt;</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="readme.html" title="&lt;no title&gt;"
>next</a> |</li>
<li><a href="#">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage"
accesskey="N">next</a> |</li>
@ -127,6 +130,9 @@ you through the process.</p>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage"
>next</a> |</li>

View File

@ -1,144 +0,0 @@
<!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>Installation &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="Usage" href="usage.html" />
<link rel="prev" title="&lt;no title&gt;" href="readme.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="usage.html" title="Usage"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="readme.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<div class="section" id="stable-release">
<h2>Stable release<a class="headerlink" href="#stable-release" title="Permalink to this headline"></a></h2>
<p>To install py-polymorphic-loader, run this command in your terminal:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> pip install py-polymorphic-loader
</pre></div>
</div>
<p>If you don&#8217;t have <a class="reference external" href="https://pip.pypa.io">pip</a> installed, this <a class="reference external" href="http://docs.python-guide.org/en/latest/starting/installation/">Python installation guide</a> can guide
you through the process.</p>
</div>
<div class="section" id="from-sources">
<h2>From sources<a class="headerlink" href="#from-sources" title="Permalink to this headline"></a></h2>
<p>The sources for py-polymorphic-loader can be downloaded from the <a class="reference external" href="https://github.com/elfsternberg/py-polymorphic-loader">Github repo</a>.</p>
<p>You can either clone the public repository:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> git clone git://github.com/elfsternberg/py-polymorphic-loader
</pre></div>
</div>
<p>Or download the <a class="reference external" href="https://github.com/elfsternberg/py-polymorphic-loader/tarball/master">tarball</a>:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> curl -OL https://github.com/elfsternberg/py-polymorphic-loader/tarball/master
</pre></div>
</div>
<p>Once you have a copy of the source, you can install it with:</p>
<div class="highlight-console"><div class="highlight"><pre><span class="gp">$</span> python setup.py install
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#stable-release">Stable release</a></li>
<li><a class="reference internal" href="#from-sources">From sources</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="readme.html"
title="previous chapter">&lt;no title&gt;</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="usage.html"
title="next chapter">Usage</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/installation.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="usage.html" title="Usage"
>next</a> |</li>
<li class="right" >
<a href="readme.html" title="&lt;no title&gt;"
>previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -6,10 +6,10 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>&lt;no title&gt; &mdash; polyloader 0.1.0 documentation</title>
<title>polyloader &mdash; polyloader 0.1.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="default.css" type="text/css" />
<link rel="stylesheet" href="pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
@ -20,12 +20,10 @@
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="&lt;no title&gt;" href="authors.html" />
<link rel="prev" title="Usage" href="usage.html" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="underscore.js"></script>
<script type="text/javascript" src="doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -35,11 +33,8 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage"
accesskey="P">previous</a> |</li>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -49,22 +44,27 @@
<div class="bodywrapper">
<div class="body">
<div class="section" id="polyloader">
<h1>polyloader<a class="headerlink" href="#polyloader" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="polyloader.html">polyloader package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="polyloader.html#module-polyloader">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="usage.html"
title="previous chapter">Usage</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="authors.html"
title="next chapter">&lt;no title&gt;</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contributing.txt"
<li><a href="_sources/modules.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
@ -91,11 +91,8 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
>next</a> |</li>
<li class="right" >
<a href="usage.html" title="Usage"
>previous</a> |</li>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>

Binary file not shown.

View File

@ -6,10 +6,10 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Usage &mdash; polyloader 0.1.0 documentation</title>
<title>polyloader package &mdash; polyloader 0.1.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="default.css" type="text/css" />
<link rel="stylesheet" href="pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
@ -20,12 +20,10 @@
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="&lt;no title&gt;" href="contributing.html" />
<link rel="prev" title="Installation" href="installation.html" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="underscore.js"></script>
<script type="text/javascript" src="doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
</head>
<body>
<div class="related">
@ -35,11 +33,8 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="P">previous</a> |</li>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -49,11 +44,20 @@
<div class="bodywrapper">
<div class="body">
<div class="section" id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h1>
<p>To use py-polymorphic-loader in a project:</p>
<div class="highlight-python"><div class="highlight"><pre>import py-polymorphic-loader
</pre></div>
<div class="section" id="polyloader-package">
<h1>polyloader package<a class="headerlink" href="#polyloader-package" title="Permalink to this headline"></a></h1>
<div class="section" id="module-polyloader">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-polyloader" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="polyloader.install">
<tt class="descclassname">polyloader.</tt><tt class="descname">install</tt><big>(</big><em>compiler</em>, <em>suffixes</em><big>)</big><a class="headerlink" href="#polyloader.install" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="polyloader.reset">
<tt class="descclassname">polyloader.</tt><tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#polyloader.reset" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
@ -63,15 +67,17 @@
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="installation.html"
title="previous chapter">Installation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="contributing.html"
title="next chapter">&lt;no title&gt;</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">polyloader package</a><ul>
<li><a class="reference internal" href="#module-polyloader">Module contents</a></li>
</ul>
</li>
</ul>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/usage.txt"
<li><a href="_sources/polyloader.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
@ -98,11 +104,8 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
>next</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
>previous</a> |</li>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>

View File

@ -6,10 +6,10 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>&lt;no title&gt; &mdash; polyloader 0.1.0 documentation</title>
<title>Python Module Index &mdash; polyloader 0.1.0 documentation</title>
<link rel="stylesheet" href="static/default.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="default.css" type="text/css" />
<link rel="stylesheet" href="pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
@ -20,12 +20,17 @@
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="underscore.js"></script>
<script type="text/javascript" src="doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="&lt;no title&gt;" href="todo.html" />
<link rel="prev" title="&lt;no title&gt;" href="authors.html" />
<script type="text/javascript">
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
</head>
<body>
<div class="related">
@ -35,11 +40,8 @@
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="todo.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -49,24 +51,30 @@
<div class="bodywrapper">
<div class="body">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-p"><strong>p</strong></a>
</div>
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
<tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
<tr class="cap" id="cap-p"><td></td><td>
<strong>p</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="polyloader.html#module-polyloader"><tt class="xref">polyloader</tt></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="authors.html"
title="previous chapter">&lt;no title&gt;</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="todo.html"
title="next chapter">&lt;no title&gt;</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/history.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
@ -91,11 +99,8 @@
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="todo.html" title="&lt;no title&gt;"
>next</a> |</li>
<li class="right" >
<a href="authors.html" title="&lt;no title&gt;"
>previous</a> |</li>
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
@ -90,6 +93,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>

View File

@ -1,107 +0,0 @@
<!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>&lt;no title&gt; &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="next" title="Installation" href="installation.html" />
<link rel="prev" title="Welcome to py-polymorphic-loaders documentation!" href="index.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="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to py-polymorphic-loaders documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to py-polymorphic-loader&#8217;s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to py-polymorphic-loaders documentation!"
>previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -40,6 +40,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
@ -88,6 +91,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>

View File

@ -1,99 +0,0 @@
<!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>Search &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<script type="text/javascript" src="static/searchtools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script type="text/javascript" id="searchindexloader"></script>
</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><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1 id="search-documentation">Search</h1>
<div id="fallback" class="admonition warning">
<script type="text/javascript">$('#fallback').hide();</script>
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
<p>
From here you can search these documents. Enter your search
words into the box below and click "search". Note that the search
function will automatically search for all of the words. Pages
containing fewer words won't appear in the result list.
</p>
<form action="" method="get">
<input type="text" name="q" value="" />
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
</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"
>index</a></li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -1 +1 @@
Search.setIndex({envversion:42,terms:{compil:6,set:6,suffix:6,creat:6,process:1,onc:1,modul:0,remov:6,automat:6,pip:1,through:1,have:1,instal:[],tarbal:1,stabl:[],download:1,guid:1,assum:6,your:1,index:0,git:1,from:[],activ:6,content:0,leav:6,which:6,pair:6,master:1,you:1,"public":1,either:1,elfsternberg:1,sourc:[],run:[6,1],context:6,python:[6,1],upon:6,clone:1,copi:1,usag:[],curl:1,standard:6,repo:1,scope:6,mechan:6,repositori:1,termin:1,releas:[],last:6,search:0,github:1,don:1,setup:1,current:6,http:1,manag:6,project:3,polyload:6,instanc:6,command:1,can:1,thi:1,lifetim:6,com:1,page:0,"import":3},objtypes:{},objnames:{},filenames:["index","installation","contributing","usage","authors","readme","todo","history"],titles:["Welcome to py-polymorphic-loader&#8217;s documentation!","Installation","&lt;no title&gt;","Usage","&lt;no title&gt;","&lt;no title&gt;","&lt;no title&gt;","&lt;no title&gt;"],objects:{},titleterms:{polymorph:0,sourc:1,from:1,welcom:0,usag:3,indic:0,loader:0,tabl:0,releas:1,stabl:1,document:0,instal:1}})
Search.setIndex({envversion:42,terms:{compil:[7,8],set:8,suffix:[7,8],creat:8,process:1,onc:1,modul:[0,2],automat:8,pip:1,through:1,have:1,instal:0,tarbal:1,stabl:0,download:1,guid:1,assum:8,your:1,page:0,index:0,git:1,from:0,activ:8,content:[0,2],leav:8,which:8,master:1,you:1,"public":1,can:1,elfsternberg:1,setup:1,sourc:0,run:[8,1],thi:1,python:[8,1],usag:0,clone:1,copi:1,upon:8,curl:1,standard:8,repo:1,releas:0,mechan:8,repositori:1,termin:1,pair:8,don:1,reset:7,search:0,github:1,last:8,packag:2,remov:8,current:8,http:1,manag:8,project:6,instanc:8,command:1,either:1,context:8,lifetim:8,com:1,scope:8,"import":6},objtypes:{"0":"py:module","1":"py:function"},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},filenames:["index","installation","modules","contributing","readme","authors","usage","polyloader","todo","history"],titles:["Welcome to py-polymorphic-loader&#8217;s documentation!","Installation","polyloader","&lt;no title&gt;","&lt;no title&gt;","&lt;no title&gt;","Usage","polyloader package","&lt;no title&gt;","&lt;no title&gt;"],objects:{"":{polyloader:[7,0,0,"-"]},polyloader:{reset:[7,1,1,""],install:[7,1,1,""]}},titleterms:{polymorph:0,sourc:1,from:1,welcom:0,modul:7,usag:6,indic:0,loader:0,content:7,packag:7,polyload:[7,2],tabl:0,releas:1,stabl:1,document:0,instal:1}})

View File

@ -38,12 +38,12 @@ help:
@echo " linkcheck to check all external links for integrity"
clean:
rm -rf $(BUILDDIR)/*
rm -rf $(BUILDDIR)/doctrees $(BUILDDIR)/_* $(BUILDDIR)/*.*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@echo "Build finished. The HTML pages are in $(BUILDDIR)."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

7
docs/src/modules.rst Normal file
View File

@ -0,0 +1,7 @@
polyloader
==========
.. toctree::
:maxdepth: 4
polyloader

10
docs/src/polyloader.rst Normal file
View File

@ -0,0 +1,10 @@
polyloader package
==================
Module contents
---------------
.. automodule:: polyloader
:members:
:undoc-members:
:show-inheritance:

View File

@ -33,6 +33,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
@ -93,6 +96,9 @@ that pair upon leaving the scope.</li>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
>previous</a> |</li>

View File

@ -1,107 +0,0 @@
<!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>&lt;no title&gt; &mdash; polyloader 0.1.0 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: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="polyloader 0.1.0 documentation" href="index.html" />
<link rel="prev" title="&lt;no title&gt;" href="history.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="history.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<p>Currently assumes that Polyloaders last for the lifetime of the Python
instance. There is no standardized mechanism for removing a
compiler/suffix set from a running instance.</p>
<ol class="arabic simple">
<li>Create a standardized mechanism for removing a compiler/suffix from
the running instance.</li>
<li>Create a &#8216;with&#8217; context manager that creates a scope in which a
Polyloader compiler/suffix pair is active, and automatically removes
that pair upon leaving the scope.</li>
</ol>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="history.html"
title="previous chapter">&lt;no title&gt;</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/todo.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="history.html" title="&lt;no title&gt;"
>previous</a> |</li>
<li><a href="index.html">polyloader 0.1.0 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2016, Kenneth M. &#34;Elf&#34; Sternberg.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>

View File

@ -34,6 +34,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
@ -97,6 +100,9 @@
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="contributing.html" title="&lt;no title&gt;"
>next</a> |</li>