Publish new build of docs

Author: github-actions[bot]

dev/_sources/events/index.rst.txt

@@ -415,33 +415,39 @@ FileSelected
 
    * ``name``: the file's name
    * ``path``: the file's path within its storage location
-   * ``origin``: the origin storage location of the file, either ``local`` or ``sdcard``
+   * ``origin``: the origin storage location of the file, either ``local`` or ``printer``
 
    .. versionchanged:: 1.4.0
 
 FileDeselected
    No file is selected any more for printing.
 
 TransferStarted
-   A file transfer to the printer's SD has started.
+   A file transfer to the printer's storage has started.
 
    Payload:
 
-   * ``local``: the file's name as stored locally
-   * ``remote``: the file's name as stored on SD
+   * ``remote``: the file's name as stored on the printer
 
    **Note:** Name changed in version 1.1.0
 
    .. versionchanged:: 1.1.0
 
+   .. versionchanged:: 2.0.0
+
+      Deprecated ``local`` payload, it's always the same as ``remote``.
+
 TransferDone
-   A file transfer to the printer's SD has finished.
+   A file transfer to the printer's storage has finished.
 
    Payload:
 
    * ``time``: the time it took for the transfer to complete in seconds
-   * ``local``: the file's name as stored locally
-   * ``remote``: the file's name as stored on SD
+   * ``remote``: the file's name as stored on the printer
+
+   .. versionchanged:: 2.0.0
+
+      Deprecated ``local`` payload, it's always the same as ``remote``.
 
 .. _sec-events-available_events-printing:
 

dev/api/job.html

@@ -1731,47 +1731,52 @@ <h3 id="job-information-response"><span id="sec-api-job-datamodel-response"></sp
 <td><p>Last modification date of the file being printed as timestamp</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.estimatedPrintTime</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.file.upload</span></code></p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
+<td><p>Whether this file is currently being uploaded (true) or already available on the storage (false)</p></td>
+<td><p><em>unset</em></p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.estimatedPrintTime</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
 <td><p>Estimated print time in seconds, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.filament</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.filament</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">dict[str,</span> <span class="pre">Optional[dict[str,</span> <span class="pre">float]]]</span></code></p></td>
 <td><p>Filament usage information as mapping from printer profile to mappings from tool to used length, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.user</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.user</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>The user who started the job, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.*</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.*</span></code></p></td>
 <td></td>
 <td><p>Information about the current job’s progress</p></td>
 <td></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.completion</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.completion</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Completion in percentage, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.filepos</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.filepos</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Current file position, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTime</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTime</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Print time so far</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeft</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeft</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Estimated print time left</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeftOrigin</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeftOrigin</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Origin of estimate.</p>
 <p>E.g.:</p>
@@ -1787,12 +1792,12 @@ <h3 id="job-information-response"><span id="sec-api-job-datamodel-response"></sp
 </td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">state</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">state</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Current state</p></td>
 <td><p><em>required</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">error</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">error</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Error, if any</p></td>
 <td><p><em>unset</em></p></td>
@@ -1855,52 +1860,57 @@ <h3 id="job-information-response-pre-1-12-0"><span id="sec-api-job-datamodel-res
 <td><p>Last modification date of the file being printed as timestamp</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.estimatedPrintTime</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.file.upload</span></code></p></td>
+<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
+<td><p>Whether this file is currently being uploaded (true) or already available on the storage (false)</p></td>
+<td><p><em>unset</em></p></td>
+</tr>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.estimatedPrintTime</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
 <td><p>Estimated print time in seconds, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.filament</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.filament</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">dict[str,</span> <span class="pre">Optional[dict[str,</span> <span class="pre">float]]]</span></code></p></td>
 <td><p>Filament usage information as mapping from printer profile to mappings from tool to used length, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.user</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.user</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>The user who started the job, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">job.lastPrintTime</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">job.lastPrintTime</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
 <td><p>The last print time in seconds</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.*</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.*</span></code></p></td>
 <td></td>
 <td><p>Information about the current job’s progress</p></td>
 <td></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.completion</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.completion</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Completion in percentage, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.filepos</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.filepos</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Current file position, if known</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTime</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTime</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Print time so far</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeft</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeft</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
 <td><p>Estimated print time left</p></td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeftOrigin</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">progress.printTimeLeftOrigin</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Origin of estimate.</p>
 <p>E.g.:</p>
@@ -1916,12 +1926,12 @@ <h3 id="job-information-response-pre-1-12-0"><span id="sec-api-job-datamodel-res
 </td>
 <td><p><em>unset</em></p></td>
 </tr>
-<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">state</span></code></p></td>
+<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">state</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Current state</p></td>
 <td><p><em>required</em></p></td>
 </tr>
-<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">error</span></code></p></td>
+<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">error</span></code></p></td>
 <td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
 <td><p>Error, if any</p></td>
 <td><p><em>unset</em></p></td>

dev/events/index.html

@@ -1264,32 +1264,36 @@ <h3 id="file-handling"><span id="sec-events-available-events-file-handling"></sp
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">name</span></code>: the file’s name</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">path</span></code>: the file’s path within its storage location</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code>: the origin storage location of the file, either <code class="docutils literal notranslate"><span class="pre">local</span></code> or <code class="docutils literal notranslate"><span class="pre">sdcard</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">origin</span></code>: the origin storage location of the file, either <code class="docutils literal notranslate"><span class="pre">local</span></code> or <code class="docutils literal notranslate"><span class="pre">printer</span></code></p></li>
 </ul>
 <div class="admonition versionchanged">
 <p class="admonition-title"><span class="versionmodified changed">Changed in version 1.4.0.</span></p>
 </div>
 </dd>
 <dt>FileDeselected</dt><dd><p>No file is selected any more for printing.</p>
 </dd>
-<dt>TransferStarted</dt><dd><p>A file transfer to the printer’s SD has started.</p>
+<dt>TransferStarted</dt><dd><p>A file transfer to the printer’s storage has started.</p>
 <p>Payload:</p>
 <ul class="simple">
-<li><p><code class="docutils literal notranslate"><span class="pre">local</span></code>: the file’s name as stored locally</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">remote</span></code>: the file’s name as stored on SD</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">remote</span></code>: the file’s name as stored on the printer</p></li>
 </ul>
 <p><strong>Note:</strong> Name changed in version 1.1.0</p>
 <div class="admonition versionchanged">
 <p class="admonition-title"><span class="versionmodified changed">Changed in version 1.1.0.</span></p>
 </div>
+<div class="admonition versionchanged">
+<p class="admonition-title"><span class="versionmodified changed">Changed in version 2.0.0: </span>Deprecated <code class="docutils literal notranslate"><span class="pre">local</span></code> payload, it’s always the same as <code class="docutils literal notranslate"><span class="pre">remote</span></code>.</p>
+</div>
 </dd>
-<dt>TransferDone</dt><dd><p>A file transfer to the printer’s SD has finished.</p>
+<dt>TransferDone</dt><dd><p>A file transfer to the printer’s storage has finished.</p>
 <p>Payload:</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">time</span></code>: the time it took for the transfer to complete in seconds</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">local</span></code>: the file’s name as stored locally</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">remote</span></code>: the file’s name as stored on SD</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">remote</span></code>: the file’s name as stored on the printer</p></li>
 </ul>
+<div class="admonition versionchanged">
+<p class="admonition-title"><span class="versionmodified changed">Changed in version 2.0.0: </span>Deprecated <code class="docutils literal notranslate"><span class="pre">local</span></code> payload, it’s always the same as <code class="docutils literal notranslate"><span class="pre">remote</span></code>.</p>
+</div>
 </dd>
 </dl>
 <h3 id="printing"><span id="sec-events-available-events-printing"></span>Printing<a class="headerlink" href="#printing" title="Link to this heading">¶</a></h3>

dev/genindex.html

@@ -3612,8 +3612,6 @@ <h2 id="R">R</h2>
 </li>
       </ul></li>
       <li><a href="modules/schema.html#octoprint.schema.config.feature.FeatureConfig.rememberFileFolder">rememberFileFolder (octoprint.schema.config.feature.FeatureConfig attribute)</a>
-</li>
-      <li><a href="modules/printer.html#octoprint.printer.job.UploadJob.remote_path">remote_path (octoprint.printer.job.UploadJob attribute)</a>
 </li>
       <li><a href="modules/schema.html#octoprint.schema.config.access_control.AccessControlConfig.remoteGroupsHeader">remoteGroupsHeader (octoprint.schema.config.access_control.AccessControlConfig attribute)</a>
 </li>

dev/modules/index.html

@@ -2347,7 +2347,6 @@ <h1 id="internal-modules"><span id="sec-modules"></span>Internal Modules<a class
 </li>
 <li class="toctree-l2"><a class="reference internal" href="printer.html#octoprint.printer.job.UploadJob">octoprint.printer.job.UploadJob</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="printer.html#octoprint.printer.job.UploadJob-config">Config</a></li>
-<li class="toctree-l3"><a class="reference internal" href="printer.html#octoprint.printer.job.UploadJob.remote_path">remote_path</a></li>
 </ul>
 </li>
 </ul>

dev/modules/printer.html

@@ -11691,30 +11691,6 @@
 
 
 
-              
-                
-  
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="#octoprint.printer.job.UploadJob.remote_path" class="md-nav__link">
-        
-  
-  
-  <span class="md-ellipsis">
-    <span title="octoprint.printer.job.UploadJob.remote_path (Python field)"><span>remote_<wbr>path</span></span>
-    
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
           </ul>
         </nav>
 
@@ -21440,11 +21416,6 @@ <h1 id="module-octoprint.printer.job"><span id="octoprint-printer-job"></span><s
 </ul>
 </dd>
 </dl>
-<dl class="py attribute pydantic_field objdesc">
-<dt class="sig sig-object highlight py" id="octoprint.printer.job.UploadJob.remote_path">
-<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remote_path</span></span><span class="p"> <span class="pre">:</span> </span><span class="desctype"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.14)"><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://docs.python.org/3/library/constants.html#None" title="(in Python v3.14)"><span class="pre">None</span></a></span><span class="p"> <span class="pre">=</span> </span><code class="code python docutils literal highlight highlight-python"><span class="kc">None</span></code><a class="headerlink" href="#octoprint.printer.job.UploadJob.remote_path" title="Link to this definition">¶</a></dt>
-<dd></dd></dl>
-
 </dd></dl>
 
 <h1 id="module-octoprint.printer.profile"><span id="octoprint-printer-profile"></span><span id="sec-modules-printer-profile"></span>octoprint.printer.profile<a class="headerlink" href="#module-octoprint.printer.profile" title="Link to this heading">¶</a></h1>