Merge pull request #144 from Roman-Supernova-PIT/docfix

rknop · rknop · commit 52b2f7839d18 · 2025-09-08T19:22:41.000Z
Fix api documentation so doc pages build 3fbaab0
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 9a865f13bbb3c0943a7262f79fa650f4
+config: 666fab85d7f77e22666dc153efd7fbb6
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -4,12 +4,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Overview: module code &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
-    <script src="../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../_static/documentation_options.js?v=78713410"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
diff --git a/_modules/phrosty/imagesubtraction.html b/_modules/phrosty/imagesubtraction.html
@@ -4,12 +4,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>phrosty.imagesubtraction &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>phrosty.imagesubtraction &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=4ae1632d" />
-    <script src="../../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../../_static/documentation_options.js?v=78713410"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
diff --git a/_modules/phrosty/pipeline.html b/_modules/phrosty/pipeline.html
@@ -4,12 +4,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>phrosty.pipeline &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>phrosty.pipeline &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=4ae1632d" />
-    <script src="../../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../../_static/documentation_options.js?v=78713410"></script>
     <script src="../../_static/doctools.js?v=9bcbadda"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
@@ -942,12 +942,12 @@ <h1>Source code for phrosty.pipeline</h1><div class="highlight"><pre>
 
                 <span class="n">partialstamp</span> <span class="o">=</span> <span class="n">partial</span><span class="p">(</span><span class="n">stampmaker</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">diaobj</span><span class="o">.</span><span class="n">ra</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">diaobj</span><span class="o">.</span><span class="n">dec</span><span class="p">,</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="mi">100</span><span class="p">,</span> <span class="mi">100</span><span class="p">]))</span>
                 <span class="c1"># template path, savedir, savename</span>
-                <span class="n">templstamp_args</span> <span class="o">=</span> <span class="p">(</span> <span class="p">(</span><span class="n">ti</span><span class="o">.</span><span class="n">image</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dia_out_dir</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;stamp_</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">ti</span><span class="o">.</span><span class="n">image</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
-                                     <span class="k">for</span> <span class="n">ti</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">template_images</span> <span class="p">)</span>
-
+                <span class="n">templstamp_args</span> <span class="o">=</span> <span class="p">(</span> <span class="p">(</span><span class="n">ti</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dia_out_dir</span><span class="p">,</span> <span class="sa">f</span><span class="s1">&#39;stamp_</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">ti</span><span class="o">.</span><span class="n">image</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="si">}</span><span class="s1">&#39;</span><span class="p">)</span>
+                                    <span class="k">for</span> <span class="n">ti</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">template_images</span> <span class="p">)</span>
                 <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">nwrite</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
                     <span class="k">with</span> <span class="n">Pool</span><span class="p">(</span> <span class="bp">self</span><span class="o">.</span><span class="n">nwrite</span> <span class="p">)</span> <span class="k">as</span> <span class="n">templ_stamp_pool</span><span class="p">:</span>
-                        <span class="n">templ_stamp_pool</span><span class="o">.</span><span class="n">starmap_async</span><span class="p">(</span> <span class="n">partialstamp</span><span class="p">,</span> <span class="n">templstamp_args</span> <span class="p">)</span>
+                        <span class="n">templ_stamp_pool</span><span class="o">.</span><span class="n">starmap_async</span><span class="p">(</span> <span class="n">partialstamp</span><span class="p">,</span> <span class="n">templstamp_args</span><span class="p">,</span>
+                                                        <span class="n">error_callback</span><span class="o">=</span><span class="n">log_stamp_err</span> <span class="p">)</span>
                         <span class="n">templ_stamp_pool</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
                         <span class="n">templ_stamp_pool</span><span class="o">.</span><span class="n">join</span><span class="p">()</span>
 
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.dev1+g34d375aa8',
+    VERSION: '0.1.dev1+g3fbaab0a0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
diff --git a/api.html b/api.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>phrosty API &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>phrosty API &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
diff --git a/api/phrosty.imagesubtraction.sky_subtract.html b/api/phrosty.imagesubtraction.sky_subtract.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>sky_subtract &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>sky_subtract &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
-    <script src="../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../_static/documentation_options.js?v=78713410"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
diff --git a/api/phrosty.imagesubtraction.stampmaker.html b/api/phrosty.imagesubtraction.stampmaker.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>stampmaker &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>stampmaker &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
-    <script src="../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../_static/documentation_options.js?v=78713410"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
diff --git a/api/phrosty.pipeline.Pipeline.html b/api/phrosty.pipeline.Pipeline.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Pipeline &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Pipeline &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
-    <script src="../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../_static/documentation_options.js?v=78713410"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
diff --git a/api/phrosty.pipeline.PipelineImage.html b/api/phrosty.pipeline.PipelineImage.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>PipelineImage &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>PipelineImage &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="../_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
-    <script src="../_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="../_static/documentation_options.js?v=78713410"></script>
     <script src="../_static/doctools.js?v=9bcbadda"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../genindex.html" />
diff --git a/changes.html b/changes.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Change Log &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Change Log &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
diff --git a/development.html b/development.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Development &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Development &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
diff --git a/genindex.html b/genindex.html
@@ -4,12 +4,12 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Index &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="#" />
diff --git a/index.html b/index.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>phrosty Documentation &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>phrosty Documentation &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
@@ -94,7 +94,7 @@ <h3 id="searchlabel">Quick search</h3>
   <section id="phrosty-documentation">
 <h1>phrosty Documentation<a class="headerlink" href="#phrosty-documentation" title="Link to this heading">¶</a></h1>
 <p>This is the documentation for phrosty.</p>
-<p><strong>Version</strong>: 0.1.dev1+g34d375aa8</p>
+<p><strong>Version</strong>: 0.1.dev1+g3fbaab0a0</p>
 <p>This package contains the Python software suite developed for use with the Roman Telescope project, as part of the Roman Supernova Project Implementation Team (PIT) project.</p>
 <section id="statement-of-need">
 <h2>Statement of Need<a class="headerlink" href="#statement-of-need" title="Link to this heading">¶</a></h2>
diff --git a/installation.html b/installation.html
@@ -5,12 +5,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Installation &#8212; phrosty 0.1.dev1+g34d375aa8 documentation</title>
+    <title>Installation &#8212; phrosty 0.1.dev1+g3fbaab0a0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
     <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5a6b8c39" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=f3bc516d" />
     <link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
-    <script src="_static/documentation_options.js?v=5be85a4f"></script>
+    <script src="_static/documentation_options.js?v=78713410"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="genindex.html" />
diff --git a/objects.inv b/objects.inv
@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: phrosty
-# Version: 0.1.dev1+g34d375aa8
+# Version: 0.1.dev1+g3fbaab0a0
 # The remainder of this file is compressed using zlib.
 xڵV�n�0��+�W��5��iI!�ə���ņ"Y�r��/)j�/r!߬�{o����J-�mV��;0��j�Y&V�}%����b��V�S�$�q��	�ʼ5���*E-����2���wci�*��*'��p&`��{�*������x��!$��҆����4ω�D��pkH�B�t��N*r�4�L���{X�GƁj�mAX��v.I�$���e��U}'���f�^:˭�*�%L���jS�
 )u�pf�C($QԖK�����w̲�5�@
diff --git a/py-modindex.html b/py-modindex.html
diff --git a/search.html b/search.html
diff --git a/searchindex.js b/searchindex.js
diff --git a/usage.html b/usage.html
