update GitHub Pages documentation site

openssa.l2.planning.abstract.html

@@ -91,7 +91,8 @@
 <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">¶</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html"><code class="docutils literal notranslate"><span class="pre">PLAN</span></code></a></li>
+<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html">ABSTRACT TASK PLAN INTERFACE</a></li>
+<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html#openssa.l2.planning.abstract.plan.PLAN"><code class="docutils literal notranslate"><span class="pre">PLAN</span></code></a></li>
 <li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html#openssa.l2.planning.abstract.plan.AbstractPlan"><code class="docutils literal notranslate"><span class="pre">AbstractPlan</span></code></a><ul>
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html#openssa.l2.planning.abstract.plan.AbstractPlan.task"><code class="docutils literal notranslate"><span class="pre">AbstractPlan.task</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html#openssa.l2.planning.abstract.plan.AbstractPlan.sub_plans"><code class="docutils literal notranslate"><span class="pre">AbstractPlan.sub_plans</span></code></a></li>
@@ -101,7 +102,8 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.plan.html#openssa.l2.planning.abstract.plan.AbstractPlan.execute"><code class="docutils literal notranslate"><span class="pre">AbstractPlan.execute()</span></code></a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html"><code class="docutils literal notranslate"><span class="pre">AbstractPlanner</span></code></a><ul>
+<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html">ABSTRACT TASK PLANNER INTERFACE</a></li>
+<li class="toctree-l1"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html#openssa.l2.planning.abstract.planner.AbstractPlanner"><code class="docutils literal notranslate"><span class="pre">AbstractPlanner</span></code></a><ul>
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html#openssa.l2.planning.abstract.planner.AbstractPlanner.lm"><code class="docutils literal notranslate"><span class="pre">AbstractPlanner.lm</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html#openssa.l2.planning.abstract.planner.AbstractPlanner.max_depth"><code class="docutils literal notranslate"><span class="pre">AbstractPlanner.max_depth</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="openssa.l2.planning.abstract.planner.html#openssa.l2.planning.abstract.planner.AbstractPlanner.max_subtasks_per_decomp"><code class="docutils literal notranslate"><span class="pre">AbstractPlanner.max_subtasks_per_decomp</span></code></a></li>

openssa.l2.planning.abstract.plan.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" />
 
-      <title>&lt;no title&gt;</title>
+      <title>ABSTRACT TASK PLAN INTERFACE</title>
 
           <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
           <link rel="stylesheet" href="_static/theme.css " type="text/css" />
@@ -74,7 +74,7 @@
   <ul class="breadcrumbs">
     <li><a href="index.html">Docs</a> &raquo;</li>
 
-    <li>&lt;no title&gt;</li>
+    <li>ABSTRACT TASK PLAN INTERFACE</li>
   </ul>
 
 
@@ -85,22 +85,28 @@
 <hr>
           <div class="content" role="main" v-pre>
 
-  <p id="module-openssa.l2.planning.abstract.plan">Abstract Plan.</p>
+  <section id="abstract-task-plan-interface">
+<span id="module-openssa.l2.planning.abstract.plan"></span><h1>ABSTRACT TASK PLAN INTERFACE<a class="headerlink" href="#abstract-task-plan-interface" title="Link to this heading">¶</a></h1>
+<p><cite>AbstractPlan</cite> is <cite>OpenSSA</cite>’s abstract base class for problem-solving task plans.</p>
+<p>A plan has a target <cite>task</cite> to solve, and can contain decomposed <cite>sub_plans</cite> for solving that <cite>task</cite>.</p>
+<p>A plan can be executed through its own <cite>.execute(…)</cite> method,
+by a specified Reasoner that optionally takes into account some given domain-specific Knowledge and/or other results.
+The plan execution returns a string result.</p>
+</section>
 <dl class="py class">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.PLAN">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openssa.l2.planning.abstract.plan.</span></span><span class="sig-name descname"><span class="pre">PLAN</span></span><a class="headerlink" href="#openssa.l2.planning.abstract.plan.PLAN" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleNamespace</span></code></p>
-<p>Plan Repr.</p>
 </dd></dl>
 
 <dl class="py class">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.AbstractPlan">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openssa.l2.planning.abstract.plan.</span></span><span class="sig-name descname"><span class="pre">AbstractPlan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task:</span> <span class="pre">ATask</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_plans:</span> <span class="pre">list[Self]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">openssa.l2.planning.abstract.plan.</span></span><span class="sig-name descname"><span class="pre">AbstractPlan</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">task:</span> <span class="pre">Task</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sub_plans:</span> <span class="pre">list[Self]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan" title="Link to this definition">¶</a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
 <p>Abstract Plan.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.AbstractPlan.task">
-<span class="sig-name descname"><span class="pre">task</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ATask</span></em><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan.task" title="Link to this definition">¶</a></dt>
+<span class="sig-name descname"><span class="pre">task</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="openssa.l2.task.task.html#openssa.l2.task.task.Task" title="openssa.l2.task.task.Task"><span class="pre">Task</span></a></em><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan.task" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py attribute">
@@ -116,18 +122,20 @@
 <dl class="py property">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.AbstractPlan.quick_repr">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quick_repr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#openssa.l2.planning.abstract.plan.PLAN" title="openssa.l2.planning.abstract.plan.PLAN"><span class="pre">PLAN</span></a></em><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan.quick_repr" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Quick, pretty-formattable/printable namespace representation.</p>
+</dd></dl>
 
 <dl class="py property">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.AbstractPlan.pformat">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pformat</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan.pformat" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Pretty-formatted string representation.</p>
+</dd></dl>
 
 <dl class="py method">
 <dt class="sig sig-object py" id="openssa.l2.planning.abstract.plan.AbstractPlan.execute">
 <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reasoner</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">AReasoner</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">knowledge</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">set</span><span class="p"><span class="pre">[</span></span><span class="pre">Knowledge</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">other_results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">AskAnsPair</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#openssa.l2.planning.abstract.plan.AbstractPlan.execute" title="Link to this definition">¶</a></dt>
-<dd><p>Execute and return result, using specified Reasoner and Knowledge to work through involved Task &amp; Sub-Tasks.</p>
-<p>Execution also optionally takes into account potentially-relevant other results from elsewhere.</p>
+<dd><p>Execute and return string result, using specified Reasoner to work through involved Task &amp; Sub-Tasks.</p>
+<p>Execution also optionally takes into account domain-specific Knowledge and/or potentially elevant other results.</p>
 </dd></dl>
 
 </dd></dl>