Update docs for 0.6.1

_sources/cli.rst.txt

@@ -27,7 +27,7 @@ See :doc:`data-process` for detail.
 .. option:: --include=DIR, -I DIR
 
    Add search locations for item specified as relative paths.
-   See also :envvar:`YP_INCLUDE_PATHS`.
+   See also :envvar:`YP_INCLUDE_PATH`.
 
 .. option:: --define=KEY=VALUE, -D KEY=VALUE
 
@@ -141,7 +141,7 @@ The following options apply to both :program:`yp-data`,
 Environment Variables
 ---------------------
 
-.. envvar:: YP_INCLUDE_PATHS
+.. envvar:: YP_INCLUDE_PATH
 
    Set the search path for include files (that are specified as relative
    locations). Expect a list of folders/directories in the same syntax as

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.5.3',
+    VERSION: '0.6.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

api.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python API &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Python API &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -68,6 +68,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.load_file"><code class="docutils literal notranslate"><span class="pre">DataProcessor.load_file()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.load_file_schema"><code class="docutils literal notranslate"><span class="pre">DataProcessor.load_file_schema()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.load_include_file"><code class="docutils literal notranslate"><span class="pre">DataProcessor.load_include_file()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.log_settings"><code class="docutils literal notranslate"><span class="pre">DataProcessor.log_settings()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.process_data"><code class="docutils literal notranslate"><span class="pre">DataProcessor.process_data()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.process_variable"><code class="docutils literal notranslate"><span class="pre">DataProcessor.process_variable()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#yamlprocessor.dataprocess.DataProcessor.validate_data"><code class="docutils literal notranslate"><span class="pre">DataProcessor.validate_data()</span></code></a></li>
@@ -162,7 +163,7 @@ <h1>Python API<a class="headerlink" href="#python-api" title="Link to this headi
 <dt class="sig sig-object py" id="yamlprocessor.dataprocess.DataProcessor..include_paths">
 <span class="sig-prename descclassname"><span class="pre">.</span></span><span class="sig-name descname"><span class="pre">include_paths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#list" title="(in Python v3.7)"><span class="pre">list</span></a></em><a class="headerlink" href="#yamlprocessor.dataprocess.DataProcessor..include_paths" title="Link to this definition">¶</a></dt>
 <dd><p>Locations for searching include files. Default is the value of the
-<span class="target" id="index-0"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">YP_INCLUDE_PATH</span></code> environment variable split into a list.</p>
+<span class="target" id="index-0"></span><a class="reference internal" href="cli.html#envvar-YP_INCLUDE_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">YP_INCLUDE_PATH</span></code></a> environment variable split into a list.</p>
 </dd></dl>
 
 <dl class="py attribute">
@@ -273,6 +274,12 @@ <h1>Python API<a class="headerlink" href="#python-api" title="Link to this headi
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="yamlprocessor.dataprocess.DataProcessor.log_settings">
+<span class="sig-name descname"><span class="pre">log_settings</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#yamlprocessor.dataprocess.DataProcessor.log_settings" title="Link to this definition">¶</a></dt>
+<dd><p>Log (info) current settings of the processor.</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="yamlprocessor.dataprocess.DataProcessor.process_data">
 <span class="sig-name descname"><span class="pre">process_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">in_filenames</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://python.readthedocs.io/en/latest/library/typing.html#typing.Iterable" title="(in Python v3.7)"><span class="pre">Iterable</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">out_filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://python.readthedocs.io/en/latest/library/stdtypes.html#str" title="(in Python v3.7)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://python.readthedocs.io/en/latest/library/constants.html#None" title="(in Python v3.7)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#yamlprocessor.dataprocess.DataProcessor.process_data" title="Link to this definition">¶</a></dt>
@@ -343,7 +350,7 @@ <h1>Python API<a class="headerlink" href="#python-api" title="Link to this headi
 
 <dl class="py function">
 <dt class="sig sig-object py" id="yamlprocessor.dataprocess.configure_basic_logging">
-<span class="sig-prename descclassname"><span class="pre">yamlprocessor.dataprocess.</span></span><span class="sig-name descname"><span class="pre">configure_basic_logging</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#yamlprocessor.dataprocess.configure_basic_logging" title="Link to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">yamlprocessor.dataprocess.</span></span><span class="sig-name descname"><span class="pre">configure_basic_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">20</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#yamlprocessor.dataprocess.configure_basic_logging" title="Link to this definition">¶</a></dt>
 <dd><p>Configure basic logging, suitable for most CLI applications.</p>
 <p>Basic no-frill format.
 Stream handler prints message on STDERR.</p>

basic-usage.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Basic Usages &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Basic Usages &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

cli.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Command Line Reference &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Command Line Reference &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -111,7 +111,7 @@ <h2>yp-data<a class="headerlink" href="#yp-data" title="Link to this heading">¶
 <dt class="sig sig-object std" id="cmdoption-yp-data-include">
 <span id="cmdoption-yp-data-I"></span><span class="sig-name descname"><span class="pre">--include</span></span><span class="sig-prename descclassname"><span class="pre">=DIR</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">-I</span></span><span class="sig-prename descclassname"> <span class="pre">DIR</span></span><a class="headerlink" href="#cmdoption-yp-data-include" title="Link to this definition">¶</a></dt>
 <dd><p>Add search locations for item specified as relative paths.
-See also <span class="target" id="index-0"></span><a class="reference internal" href="#envvar-YP_INCLUDE_PATHS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">YP_INCLUDE_PATHS</span></code></a>.</p>
+See also <span class="target" id="index-0"></span><a class="reference internal" href="#envvar-YP_INCLUDE_PATH"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">YP_INCLUDE_PATH</span></code></a>.</p>
 </dd></dl>
 
 <dl class="std option">
@@ -247,8 +247,8 @@ <h2>Common Options<a class="headerlink" href="#common-options" title="Link to th
 <section id="environment-variables">
 <h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2>
 <dl class="std envvar">
-<dt class="sig sig-object std" id="envvar-YP_INCLUDE_PATHS">
-<span class="sig-name descname"><span class="pre">YP_INCLUDE_PATHS</span></span><a class="headerlink" href="#envvar-YP_INCLUDE_PATHS" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object std" id="envvar-YP_INCLUDE_PATH">
+<span class="sig-name descname"><span class="pre">YP_INCLUDE_PATH</span></span><a class="headerlink" href="#envvar-YP_INCLUDE_PATH" title="Link to this definition">¶</a></dt>
 <dd><p>Set the search path for include files (that are specified as relative
 locations). Expect a list of folders/directories in the same syntax as
 a <code class="docutils literal notranslate"><span class="pre">PATH</span></code> like variable on the relevant platform. (E.g., a colon separated

data-preprocessor.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Data Pre-Processor &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Data Pre-Processor &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

data-process.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Data Processor &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Data Processor &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

genindex.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Index &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -13,7 +13,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -293,9 +293,7 @@ <h2 id="E">E</h2>
       <ul>
         <li><a href="api.html#index-3">NAME</a>, <a href="cli.html#index-3">[1]</a>
 </li>
-        <li><a href="api.html#index-0">YP_INCLUDE_PATH</a>
-</li>
-        <li><a href="cli.html#envvar-YP_INCLUDE_PATHS">YP_INCLUDE_PATHS</a>, <a href="cli.html#index-0">[1]</a>
+        <li><a href="api.html#index-0">YP_INCLUDE_PATH</a>, <a href="cli.html#envvar-YP_INCLUDE_PATH">[1]</a>, <a href="cli.html#index-0">[2]</a>
 </li>
         <li><a href="api.html#index-1">YP_SCHEMA_PREFIX</a>, <a href="api.html#index-4">[1]</a>, <a href="cli.html#envvar-YP_SCHEMA_PREFIX">[2]</a>, <a href="cli.html#index-1">[3]</a>, <a href="data-process.html#index-2">[4]</a>
 </li>
@@ -361,11 +359,13 @@ <h2 id="L">L</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#yamlprocessor.dataprocess.DataProcessor.load_file">load_file() (yamlprocessor.dataprocess.DataProcessor static method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#yamlprocessor.dataprocess.DataProcessor.load_file_schema">load_file_schema() (yamlprocessor.dataprocess.DataProcessor static method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#yamlprocessor.dataprocess.DataProcessor.load_include_file">load_include_file() (yamlprocessor.dataprocess.DataProcessor method)</a>
+</li>
+      <li><a href="api.html#yamlprocessor.dataprocess.DataProcessor.log_settings">log_settings() (yamlprocessor.dataprocess.DataProcessor method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -563,9 +563,7 @@ <h2 id="Y">Y</h2>
         <li><a href="cli.html#cmdoption-yp-schema-arg-SCHEMA-FILE">SCHEMA-FILE</a>
 </li>
       </ul></li>
-      <li><a href="api.html#index-0">YP_INCLUDE_PATH</a>
-</li>
-      <li><a href="cli.html#index-0">YP_INCLUDE_PATHS</a>
+      <li><a href="api.html#index-0">YP_INCLUDE_PATH</a>, <a href="cli.html#index-0">[1]</a>
 </li>
       <li><a href="api.html#index-1">YP_SCHEMA_PREFIX</a>, <a href="api.html#index-4">[1]</a>, <a href="cli.html#index-1">[2]</a>, <a href="data-process.html#index-2">[3]</a>
 </li>

index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>YAML Processor &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>YAML Processor &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

install.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Installation &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Installation &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -14,7 +14,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

py-modindex.html

@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; yamlprocessor 0.5.3 documentation</title>
+  <title>Python Module Index &mdash; yamlprocessor 0.6.1 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
 
@@ -13,7 +13,7 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/documentation_options.js?v=2a2fe768"></script>
+        <script src="_static/documentation_options.js?v=2bd037f0"></script>
         <script src="_static/doctools.js?v=9a2dae69"></script>
         <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>