Deploying to gh-pages from @ 6d4de04 🚀

api_reference/recline.arg_types.choices.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.choices">
 <span id="recline-arg-types-choices-module"></span><h1>recline.arg_types.choices module<a class="headerlink" href="#module-recline.arg_types.choices" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>A Choices type allows the CLI command writer to specify a static list of choices
 for a parameter. Once the body of the function is invoked, it is guaranteed that
 the validation was done on the parameter to make sure it matched one.</p>

api_reference/recline.arg_types.flag.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.flag">
 <span id="recline-arg-types-flag-module"></span><h1>recline.arg_types.flag module<a class="headerlink" href="#module-recline.arg_types.flag" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>A Flag type allows the CLI command writer to specify an argument that behaves
 like a boolean flag. The difference between this and declaring an argument as a
 bool is that no “true” or “false” input is expected of the user if the argument

api_reference/recline.arg_types.html

@@ -159,6 +159,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </section>
 <section id="module-recline.arg_types">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-recline.arg_types" title="Permalink to this heading"></a></h2>
+<p>Original © NetApp 2024</p>
 <p>This package contains the various custom type definitions for CLI command parameters.
 If you are defining a CLI command function that takes input with restrictions,
 you may want to use a type annotation to allow recline to do the checking for you

api_reference/recline.arg_types.positional.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.positional">
 <span id="recline-arg-types-positional-module"></span><h1>recline.arg_types.positional module<a class="headerlink" href="#module-recline.arg_types.positional" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>A Positional type allows the CLI command writer to specify an argument that the
 user will provide positionally. That is, instead of the user typing
 “-arg_name argvalue”, they can just type “argvalue”. For example:</p>

api_reference/recline.arg_types.ranged_int.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.ranged_int">
 <span id="recline-arg-types-ranged-int-module"></span><h1>recline.arg_types.ranged_int module<a class="headerlink" href="#module-recline.arg_types.ranged_int" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>A RangedInt type allows the CLI command writer to specify an integer that is only
 valid within a certain range. If the user provides a value outside of that range,
 then the parameter validation will fail and they will receive an error message.</p>

api_reference/recline.arg_types.recline_type.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.recline_type">
 <span id="recline-arg-types-recline-type-module"></span><h1>recline.arg_types.recline_type module<a class="headerlink" href="#module-recline.arg_types.recline_type" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module contains the abstract base class for all recline custom types</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="recline.arg_types.recline_type.ReclineType">

api_reference/recline.arg_types.recline_type_error.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.recline_type_error">
 <span id="recline-arg-types-recline-type-error-module"></span><h1>recline.arg_types.recline_type_error module<a class="headerlink" href="#module-recline.arg_types.recline_type_error" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module contains the error class that is raised when there is a type error
 when validating user input.</p>
 <dl class="py exception">

api_reference/recline.arg_types.remainder.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.arg_types.remainder">
 <span id="recline-arg-types-remainder-module"></span><h1>recline.arg_types.remainder module<a class="headerlink" href="#module-recline.arg_types.remainder" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>A Remainder type allows the CLI command writer to specify that an argument should
 consume all of the rest of the input from the CLI and that it will be interpreted
 inside of the command handler function.</p>

api_reference/recline.commands.async_command.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.commands.async_command">
 <span id="recline-commands-async-command-module"></span><h1>recline.commands.async_command module<a class="headerlink" href="#module-recline.commands.async_command" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This is the implementation of an async command for the recline library. It allows
 for a command to be run in the foreground or background.</p>
 <dl class="py class">

api_reference/recline.commands.builtin_commands.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.commands.builtin_commands">
 <span id="recline-commands-builtin-commands-module"></span><h1>recline.commands.builtin_commands module<a class="headerlink" href="#module-recline.commands.builtin_commands" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>The commands defined here are included with every recline application</p>
 <dl class="py exception">
 <dt class="sig sig-object py" id="recline.commands.builtin_commands.DebugInterrupt">

api_reference/recline.commands.cli_command.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.commands.cli_command">
 <span id="recline-commands-cli-command-module"></span><h1>recline.commands.cli_command module<a class="headerlink" href="#module-recline.commands.cli_command" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module contains the definition of a CLICommand object. This is the main
 driver of the recline library. Essentially, a CLICommand takes as input a wrapped
 function and parses the args and docstring so that when called from the REPL, the

api_reference/recline.commands.html

@@ -150,6 +150,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </section>
 <section id="module-recline.commands">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-recline.commands" title="Permalink to this heading"></a></h2>
+<p>Original © NetApp 2024</p>
 <p>This package contains the base command class and the builtin command for all
 recline-based applications to use.</p>
 <dl class="py exception">

api_reference/recline.commands.man_utils.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.commands.man_utils">
 <span id="recline-commands-man-utils-module"></span><h1>recline.commands.man_utils module<a class="headerlink" href="#module-recline.commands.man_utils" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module holds some utility functions used as part of the man command to format
 text from CLI commands into consistent man pages that respond to the terminal
 width.</p>

api_reference/recline.formatters.html

@@ -120,6 +120,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 </section>
 <section id="module-recline.formatters">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-recline.formatters" title="Permalink to this heading"></a></h2>
+<p>Original © NetApp 2024</p>
 <p>This package contains useful output formatters. An output formatter can be defined
 as the return type of a CLI command (using a type annotation). If one is defined,
 then the result of running the command will be passed to the output formatter

api_reference/recline.formatters.output_formatter.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.formatters.output_formatter">
 <span id="recline-formatters-output-formatter-module"></span><h1>recline.formatters.output_formatter module<a class="headerlink" href="#module-recline.formatters.output_formatter" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module contains the abstract class that all other output formatters should
 inherit from</p>
 <dl class="py class">

api_reference/recline.formatters.table_formatter.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.formatters.table_formatter">
 <span id="recline-formatters-table-formatter-module"></span><h1>recline.formatters.table_formatter module<a class="headerlink" href="#module-recline.formatters.table_formatter" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module contains a table formatter for CLI output. The table formatter expects
 output to be an iterable of dictionary-like objects. For example, if a CLI command
 returned something like:</p>

api_reference/recline.html

@@ -219,8 +219,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to thi
 </section>
 <section id="module-recline">
 <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-recline" title="Permalink to this heading"></a></h2>
-<p>Copyright (C) 2020 NetApp Inc.
-All rights reserved.</p>
+<p>Original © NetApp 2024</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="recline.command">
 <span class="sig-prename descclassname"><span class="pre">recline.</span></span><span class="sig-name descname"><span class="pre">command</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aliases</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">atstart</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">atexit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">background</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#recline.command" title="Permalink to this definition"></a></dt>

api_reference/recline.repl.completer.html

@@ -98,6 +98,7 @@
 
   <section id="module-recline.repl.completer">
 <span id="recline-repl-completer-module"></span><h1>recline.repl.completer module<a class="headerlink" href="#module-recline.repl.completer" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This module implements a readline completer for completing command names as well
 as argument names and values.</p>
 <dl class="py class">

api_reference/recline.repl.shell.html

@@ -97,6 +97,7 @@
 
   <section id="module-recline.repl.shell">
 <span id="recline-repl-shell-module"></span><h1>recline.repl.shell module<a class="headerlink" href="#module-recline.repl.shell" title="Permalink to this heading"></a></h1>
+<p>Original © NetApp 2024</p>
 <p>This is the main staring point for a recline application</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="recline.repl.shell.execute">