Skip to content

Commit 63d67d9

Browse files
Publish new build of docs
1 parent df20ed1 commit 63d67d9

File tree

4 files changed

+165
-3
lines changed

4 files changed

+165
-3
lines changed

dev/genindex.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2225,10 +2225,10 @@ <h2 id="L">L</h2>
22252225
<li><a href="modules/cli.html#octoprint.cli.plugins.OctoPrintPluginCommands.list_commands">(octoprint.cli.plugins.OctoPrintPluginCommands method)</a>
22262226
</li>
22272227
</ul></li>
2228-
</ul></td>
2229-
<td style="width: 33%; vertical-align: top;"><ul>
22302228
<li><a href="modules/filemanager.html#octoprint.filemanager.storage.StorageInterface.list_files">list_files() (octoprint.filemanager.storage.StorageInterface method)</a>
22312229
</li>
2230+
</ul></td>
2231+
<td style="width: 33%; vertical-align: top;"><ul>
22322232
<li><a href="modules/settings.html#octoprint.settings.Settings.listScripts">listScripts() (octoprint.settings.Settings method)</a>
22332233
</li>
22342234
<li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.load">load (octoprint.plugin.core.PluginInfo property)</a>
@@ -2240,6 +2240,10 @@ <h2 id="L">L</h2>
22402240
<li><a href="modules/settings.html#octoprint.settings.Settings.load_overlays">load_overlays() (octoprint.settings.Settings method)</a>
22412241
</li>
22422242
<li><a href="modules/slicing.html#octoprint.slicing.SlicingManager.load_profile">load_profile() (octoprint.slicing.SlicingManager method)</a>
2243+
</li>
2244+
<li><a href="modules/server.html#octoprint.server.load_user">load_user() (in module octoprint.server)</a>
2245+
</li>
2246+
<li><a href="modules/server.html#octoprint.server.load_user_from_request">load_user_from_request() (in module octoprint.server)</a>
22432247
</li>
22442248
<li><a href="modules/plugin.html#octoprint.plugin.core.PluginInfo.loaded">loaded (octoprint.plugin.core.PluginInfo attribute)</a>
22452249
</li>

dev/modules/index.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2952,6 +2952,8 @@ <h1 id="internal-modules"><span id="sec-modules"></span>Internal Modules<a class
29522952
<li class="toctree-l1"><a class="reference internal" href="server.html">octoprint.server</a><ul>
29532953
<li class="toctree-l2"><a class="reference internal" href="server.html#octoprint.server.CannotStartServerException">octoprint.server.CannotStartServerException</a></li>
29542954
<li class="toctree-l2"><a class="reference internal" href="server.html#octoprint.server.OctoPrintAnonymousIdentity">octoprint.server.OctoPrintAnonymousIdentity</a></li>
2955+
<li class="toctree-l2"><a class="reference internal" href="server.html#octoprint.server.load_user">octoprint.server.load_user</a></li>
2956+
<li class="toctree-l2"><a class="reference internal" href="server.html#octoprint.server.load_user_from_request">octoprint.server.load_user_from_request</a></li>
29552957
</ul>
29562958
</li>
29572959
<li class="toctree-l1"><a class="reference internal" href="server.html#module-octoprint.server.util">octoprint.server.util</a><ul>

dev/modules/server.html

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1133,6 +1133,30 @@
11331133
</span>
11341134
</a>
11351135

1136+
</li>
1137+
1138+
<li class="md-nav__item">
1139+
<a href="#octoprint.server.load_user" class="md-nav__link">
1140+
1141+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
1142+
1143+
<span class="md-ellipsis">
1144+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
1145+
</span>
1146+
</a>
1147+
1148+
</li>
1149+
1150+
<li class="md-nav__item">
1151+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
1152+
1153+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
1154+
1155+
<span class="md-ellipsis">
1156+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
1157+
</span>
1158+
</a>
1159+
11361160
</li>
11371161

11381162
</ul>
@@ -2865,6 +2889,30 @@
28652889
</span>
28662890
</a>
28672891

2892+
</li>
2893+
2894+
<li class="md-nav__item">
2895+
<a href="#octoprint.server.load_user" class="md-nav__link">
2896+
2897+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
2898+
2899+
<span class="md-ellipsis">
2900+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
2901+
</span>
2902+
</a>
2903+
2904+
</li>
2905+
2906+
<li class="md-nav__item">
2907+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
2908+
2909+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
2910+
2911+
<span class="md-ellipsis">
2912+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
2913+
</span>
2914+
</a>
2915+
28682916
</li>
28692917

28702918
</ul>
@@ -6759,6 +6807,30 @@
67596807
</span>
67606808
</a>
67616809

6810+
</li>
6811+
6812+
<li class="md-nav__item">
6813+
<a href="#octoprint.server.load_user" class="md-nav__link">
6814+
6815+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
6816+
6817+
<span class="md-ellipsis">
6818+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
6819+
</span>
6820+
</a>
6821+
6822+
</li>
6823+
6824+
<li class="md-nav__item">
6825+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
6826+
6827+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
6828+
6829+
<span class="md-ellipsis">
6830+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
6831+
</span>
6832+
</a>
6833+
67626834
</li>
67636835

67646836
</ul>
@@ -6999,6 +7071,30 @@
69997071
</span>
70007072
</a>
70017073

7074+
</li>
7075+
7076+
<li class="md-nav__item">
7077+
<a href="#octoprint.server.load_user" class="md-nav__link">
7078+
7079+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
7080+
7081+
<span class="md-ellipsis">
7082+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
7083+
</span>
7084+
</a>
7085+
7086+
</li>
7087+
7088+
<li class="md-nav__item">
7089+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
7090+
7091+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
7092+
7093+
<span class="md-ellipsis">
7094+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
7095+
</span>
7096+
</a>
7097+
70027098
</li>
70037099

70047100
</ul>
@@ -10177,6 +10273,30 @@
1017710273
</span>
1017810274
</a>
1017910275

10276+
</li>
10277+
10278+
<li class="md-nav__item">
10279+
<a href="#octoprint.server.load_user" class="md-nav__link">
10280+
10281+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
10282+
10283+
<span class="md-ellipsis">
10284+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
10285+
</span>
10286+
</a>
10287+
10288+
</li>
10289+
10290+
<li class="md-nav__item">
10291+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
10292+
10293+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
10294+
10295+
<span class="md-ellipsis">
10296+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
10297+
</span>
10298+
</a>
10299+
1018010300
</li>
1018110301

1018210302
</ul>
@@ -10406,6 +10526,30 @@
1040610526
</span>
1040710527
</a>
1040810528

10529+
</li>
10530+
10531+
<li class="md-nav__item">
10532+
<a href="#octoprint.server.load_user" class="md-nav__link">
10533+
10534+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
10535+
10536+
<span class="md-ellipsis">
10537+
<span title="octoprint.server.load_user (Python function) — Tries to load the user from the flask session"><span>octoprint.<wbr>server.<wbr>load_<wbr>user</span></span>
10538+
</span>
10539+
</a>
10540+
10541+
</li>
10542+
10543+
<li class="md-nav__item">
10544+
<a href="#octoprint.server.load_user_from_request" class="md-nav__link">
10545+
10546+
<span aria-label="Python function" class="objinfo-icon objinfo-icon__procedure" title="Python function">F</span>
10547+
10548+
<span class="md-ellipsis">
10549+
<span title="octoprint.server.load_user_from_request (Python function) — Tries to load user from API key, Basic Auth or Remote User Header"><span>octoprint.<wbr>server.<wbr>load_<wbr>user_<wbr>from_<wbr>request</span></span>
10550+
</span>
10551+
</a>
10552+
1040910553
</li>
1041010554

1041110555
</ul>
@@ -10435,6 +10579,18 @@ <h1 id="module-octoprint.server"><span id="octoprint-server"></span><span id="se
1043510579
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">octoprint.server.</span></span><span class="sig-name descname"><span class="pre">OctoPrintAnonymousIdentity</span></span><a class="headerlink" href="#octoprint.server.OctoPrintAnonymousIdentity" title="Link to this definition">¶</a></dt>
1043610580
<dd></dd></dl>
1043710581

10582+
<dl class="py function objdesc">
10583+
<dt class="sig sig-object highlight py" id="octoprint.server.load_user">
10584+
<span class="sig-prename descclassname"><span class="pre">octoprint.server.</span></span><span class="sig-name descname"><span class="pre">load_user</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.server.load_user" title="octoprint.server.load_user.userid (Python parameter)"><span class="n"><span class="pre">userid</span></span></a></em></span><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.server.load_user" title="Link to this definition">¶</a></dt>
10585+
<dd><p>Tries to load the user from the flask session</p>
10586+
</dd></dl>
10587+
10588+
<dl class="py function objdesc">
10589+
<dt class="sig sig-object highlight py" id="octoprint.server.load_user_from_request">
10590+
<span class="sig-prename descclassname"><span class="pre">octoprint.server.</span></span><span class="sig-name descname"><span class="pre">load_user_from_request</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#octoprint.server.load_user_from_request" title="octoprint.server.load_user_from_request.request (Python parameter)"><span class="n"><span class="pre">request</span></span></a></em></span><span class="sig-paren">)</span><a class="headerlink" href="#octoprint.server.load_user_from_request" title="Link to this definition">¶</a></dt>
10591+
<dd><p>Tries to load user from API key, Basic Auth or Remote User Header</p>
10592+
</dd></dl>
10593+
1043810594
<h1 id="module-octoprint.server.util"><span id="octoprint-server-util"></span><span id="sec-modules-server-util"></span>octoprint.server.util<a class="headerlink" href="#module-octoprint.server.util" title="Link to this heading">¶</a></h1>
1043910595
<dl class="py function objdesc">
1044010596
<dt class="sig sig-object highlight py" id="octoprint.server.util.corsRequestHandler">

dev/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)