Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stage 055 documentation #188

Merged
merged 22 commits into from
Jan 22, 2020
Merged

Stage 055 documentation #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
78f9de0
Added stage 055 into documentation.
Evildoor Dec 10, 2018
057f7b8
Improved the stage description.
Evildoor Dec 10, 2018
b5a56b3
Improved descriptions of functions.
Evildoor Dec 10, 2018
9775574
Renamed documents_links() function.
Evildoor Dec 10, 2018
9f5d175
Rearranged the chapters' structure.
Evildoor Jan 11, 2019
12ecc4d
Clarified define_globals() description.
Evildoor Jan 14, 2019
ad88727
Updated document_links() description.
Evildoor Jan 14, 2019
7566741
Clarified glance_parameter_extraction() description.
Evildoor Jan 14, 2019
6d4bc8d
Updated process() description.
Evildoor Jan 14, 2019
d985b51
Added spaces before brackets in stage description.
Evildoor Jan 14, 2019
432bb25
Improved process() description.
Evildoor Jan 16, 2019
df1f7e8
Add missing parameter type.
Evildoor Mar 6, 2019
c8f755e
Update fix_string() description.
Evildoor Sep 16, 2019
202471e
Merge remote branch 'origin/master' into stage-055-docs-v2
Evildoor Nov 12, 2019
ea2fd89
Add None to descriptions of return where needed.
Evildoor Nov 12, 2019
8475392
Improve the stage description.
Evildoor Nov 12, 2019
da0dcb6
Change wording for sake of consistency.
Evildoor Jan 17, 2020
dd69a67
Reword process() description.
Evildoor Jan 17, 2020
71305fc
Improve formatting of an example.
Evildoor Jan 17, 2020
2740e63
Add missing parameter type.
Evildoor Jan 17, 2020
5a74037
Correct a link.
Evildoor Jan 17, 2020
9412b5f
Correct a link.
Evildoor Jan 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
611 changes: 611 additions & 0 deletions Docs/build/html/Stages/055_documents2TTL/055_documents2TTL.html
View file
Open in desktop

Large diffs are not rendered by default.

113 changes: 113 additions & 0 deletions Docs/build/html/Stages/Stages.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@

<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Stages &#8212; Data Knowledge Base documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Stage 055" href="055_documents2TTL/055_documents2TTL.html" />
<link rel="prev" title="pyDKB.dataflow.types module" href="../pyDKB/pyDKB.dataflow.types.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<div class="section" id="stages">
<h1>Stages<a class="headerlink" href="#stages" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Stages:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="055_documents2TTL/055_documents2TTL.html">Stage 055</a></li>
</ul>
</div>
</div>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Data Knowledge Base</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Stages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="055_documents2TTL/055_documents2TTL.html">Stage 055</a></li>
</ul>
</li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li>Previous: <a href="../pyDKB/pyDKB.dataflow.types.html" title="previous chapter">pyDKB.dataflow.types module</a></li>
<li>Next: <a href="055_documents2TTL/055_documents2TTL.html" title="next chapter">Stage 055</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2018, DKB team.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>

|
<a href="../_sources/Stages/Stages.rst.txt"
rel="nofollow">Page source</a>
</div>




</body>
</html>
736 changes: 736 additions & 0 deletions Docs/build/html/_modules/055_documents2TTL/documents2ttl.html
View file
Open in desktop

Large diffs are not rendered by default.

7 changes: 6 additions & 1 deletion Docs/build/html/_modules/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,15 @@
<div class="body" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="pyDKB/common/Type.html">pyDKB.common.Type</a></li>
<ul><li><a href="055_documents2TTL/documents2ttl.html">055_documents2TTL.documents2ttl</a></li>
<li><a href="pyDKB/common/LoggableObject.html">pyDKB.common.LoggableObject</a></li>
<li><a href="pyDKB/common/Type.html">pyDKB.common.Type</a></li>
<li><a href="pyDKB/common/custom_readline.html">pyDKB.common.custom_readline</a></li>
<li><a href="pyDKB/common/exceptions.html">pyDKB.common.exceptions</a></li>
<li><a href="pyDKB/common/hdfs.html">pyDKB.common.hdfs</a></li>
<li><a href="pyDKB/common/json_utils.html">pyDKB.common.json_utils</a></li>
<li><a href="pyDKB/common/misc.html">pyDKB.common.misc</a></li>
<li><a href="pyDKB/dataflow/cds.html">pyDKB.dataflow.cds</a></li>
<li><a href="pyDKB/dataflow/communication/consumer.html">pyDKB.dataflow.communication.consumer</a></li>
<ul><li><a href="pyDKB/dataflow/communication/consumer/Consumer.html">pyDKB.dataflow.communication.consumer.Consumer</a></li>
<li><a href="pyDKB/dataflow/communication/consumer/FileConsumer.html">pyDKB.dataflow.communication.consumer.FileConsumer</a></li>
Expand Down Expand Up @@ -78,6 +82,7 @@ <h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Stages/Stages.html">Stages</a></li>
</ul>

<div class="relations">
Expand Down
118 changes: 118 additions & 0 deletions Docs/build/html/_modules/pyDKB/common/LoggableObject.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@

<!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="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pyDKB.common.LoggableObject &#8212; Data Knowledge Base documentation</title>
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></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="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />

<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for pyDKB.common.LoggableObject</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">pyDKB.common.LoggableObject</span>
<span class="sd">&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">types</span> <span class="k">import</span> <span class="n">logLevel</span>
<span class="kn">from</span> <span class="nn">misc</span> <span class="k">import</span> <span class="n">log</span>


<div class="viewcode-block" id="LoggableObject"><a class="viewcode-back" href="../../../pyDKB/pyDKB.common.LoggableObject.html#pyDKB.common.LoggableObject.LoggableObject">[docs]</a><span class="k">class</span> <span class="nc">LoggableObject</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Common ancestor for all classes that need &#39;log&#39; method. &quot;&quot;&quot;</span>

<div class="viewcode-block" id="LoggableObject.log"><a class="viewcode-back" href="../../../pyDKB/pyDKB.common.LoggableObject.html#pyDKB.common.LoggableObject.LoggableObject.log">[docs]</a> <span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">log</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">logLevel</span><span class="o">.</span><span class="n">INFO</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot; Output log message with given log level.</span>

<span class="sd"> :param message: message to output</span>
<span class="sd"> :type message: str</span>
<span class="sd"> :param level: log level of the message</span>
<span class="sd"> :type level: ``pyDKB.common.types.logLevel`` member</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">log</span><span class="p">(</span><span class="n">message</span><span class="p">,</span> <span class="n">level</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="vm">__name__</span><span class="p">)</span></div></div>
</pre></div>

</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../../index.html">Data Knowledge Base</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../Stages/Stages.html">Stages</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../index.html">Documentation overview</a><ul>
<li><a href="../../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<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>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2018, DKB team.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.6</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.11</a>

</div>




</body>
</html>
1 change: 1 addition & 0 deletions Docs/build/html/_modules/pyDKB/common/Type.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ <h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../Stages/Stages.html">Stages</a></li>
</ul>

<div class="relations">
Expand Down
1 change: 1 addition & 0 deletions Docs/build/html/_modules/pyDKB/common/custom_readline.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ <h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../Stages/Stages.html">Stages</a></li>
</ul>

<div class="relations">
Expand Down
1 change: 1 addition & 0 deletions Docs/build/html/_modules/pyDKB/common/exceptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ <h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../pyDKB/pyDKB.html">pyDKB package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../Stages/Stages.html">Stages</a></li>
</ul>

<div class="relations">
Expand Down
Loading