Skip to content

Commit

Permalink
Deployed a9d2468 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jun 15, 2024
1 parent bd7b1ca commit 1f99a2c
Show file tree
Hide file tree
Showing 14 changed files with 122 additions and 136 deletions.
8 changes: 4 additions & 4 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@


<link rel="icon" href="/assets/logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



<title>dvc-studio-client</title>



<link rel="stylesheet" href="/assets/stylesheets/main.66ac8b77.min.css">
<link rel="stylesheet" href="/assets/stylesheets/main.6543a935.min.css">


<link rel="stylesheet" href="/assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -135,7 +135,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -527,7 +527,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/", "features": [], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.a7c05c9e.min.js"></script>
<script src="/assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@


<link rel="icon" href="assets/logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



<title>dvc-studio-client</title>



<link rel="stylesheet" href="assets/stylesheets/main.66ac8b77.min.css">
<link rel="stylesheet" href="assets/stylesheets/main.6543a935.min.css">


<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -142,7 +142,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -567,7 +567,7 @@ <h1 id="welcome-to-dvc-studio-client">Welcome to dvc-studio-client</h1>
<script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="assets/javascripts/bundle.a7c05c9e.min.js"></script>
<script src="assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
68 changes: 31 additions & 37 deletions reference/dvc_studio_client/auth/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="../../../assets/logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



<title>Auth - dvc-studio-client</title>



<link rel="stylesheet" href="../../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.6543a935.min.css">


<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -144,7 +144,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -796,12 +796,11 @@ <h1>Auth</h1>


<a id="dvc_studio_client.auth"></a>
<div class="doc doc-contents first">
<div class="doc doc-contents first">



<div class="doc doc-children">

<div class="doc doc-children">



Expand All @@ -814,15 +813,14 @@ <h1>Auth</h1>
<div class="doc doc-object doc-function">



<h2 id="dvc_studio_client.auth.check_token_authentication" class="doc doc-heading">
<code class="highlight language-python"><span class="n">check_token_authentication</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">uri</span><span class="p">,</span> <span class="n">device_code</span><span class="p">)</span></code>
<code class="highlight language-python"><span class="n">check_token_authentication</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">uri</span><span class="p">,</span> <span class="n">device_code</span><span class="p">)</span></code>

</h2>


<div class="doc doc-contents ">
<div class="doc doc-contents ">

<p>Checks the authentication status of a token based on a device code and
returns access token upon successful authentication.</p>
<h4 id="dvc_studio_client.auth.check_token_authentication--parameters">Parameters</h4>
Expand All @@ -848,9 +846,9 @@ <h4 id="dvc_studio_client.auth.check_token_authentication--raises">Raises</h4>
print(&quot;Authentication expired.&quot;)
</code></pre>

<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">174</span>
<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">174</span>
<span class="normal">175</span>
<span class="normal">176</span>
<span class="normal">177</span>
Expand Down Expand Up @@ -968,24 +966,22 @@ <h4 id="dvc_studio_client.auth.check_token_authentication--raises">Raises</h4>

<span class="k">return</span> <span class="n">r</span><span class="o">.</span><span class="n">json</span><span class="p">()[</span><span class="s2">&quot;access_token&quot;</span><span class="p">]</span>
</code></pre></div></td></tr></table></div>
</details>
</div>
</details>
</div>

</div>


<div class="doc doc-object doc-function">



<h2 id="dvc_studio_client.auth.get_access_token" class="doc doc-heading">
<code class="highlight language-python"><span class="n">get_access_token</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">token_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scopes</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">client_name</span><span class="o">=</span><span class="s1">&#39;client&#39;</span><span class="p">,</span> <span class="n">open_browser</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">post_login_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_device_code</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
<code class="highlight language-python"><span class="n">get_access_token</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">token_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scopes</span><span class="o">=</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">client_name</span><span class="o">=</span><span class="s1">&#39;client&#39;</span><span class="p">,</span> <span class="n">open_browser</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">post_login_message</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">use_device_code</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>

</h2>


<div class="doc doc-contents ">
<div class="doc doc-contents ">

<p>Initiate Authentication</p>
<p>This method initiates the authentication process for a client application.
It generates a user code and a verification URI that the user needs to
Expand All @@ -1004,9 +1000,9 @@ <h4 id="dvc_studio_client.auth.get_access_token--returns">Returns</h4>
while the access token is a string representing the authorized access token.
</code></pre>

<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 34</span>
<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 34</span>
<span class="normal"> 35</span>
<span class="normal"> 36</span>
<span class="normal"> 37</span>
Expand Down Expand Up @@ -1146,24 +1142,22 @@ <h4 id="dvc_studio_client.auth.get_access_token--returns">Returns</h4>
<span class="n">access_token</span> <span class="o">=</span> <span class="n">check_token_authentication</span><span class="p">(</span><span class="n">uri</span><span class="o">=</span><span class="n">token_uri</span><span class="p">,</span> <span class="n">device_code</span><span class="o">=</span><span class="n">device_code</span><span class="p">)</span>
<span class="k">return</span> <span class="n">token_name</span><span class="p">,</span> <span class="n">access_token</span>
</code></pre></div></td></tr></table></div>
</details>
</div>
</details>
</div>

</div>


<div class="doc doc-object doc-function">



<h2 id="dvc_studio_client.auth.start_device_login" class="doc doc-heading">
<code class="highlight language-python"><span class="n">start_device_login</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">base_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">token_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scopes</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
<code class="highlight language-python"><span class="n">start_device_login</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">client_name</span><span class="p">,</span> <span class="n">base_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">token_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">scopes</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>

</h2>


<div class="doc doc-contents ">
<div class="doc doc-contents ">

<p>This method starts the device login process for Studio.</p>
<h4 id="dvc_studio_client.auth.start_device_login--parameters">Parameters</h4>
<ul>
Expand All @@ -1184,9 +1178,9 @@ <h4 id="dvc_studio_client.auth.start_device_login--raises">Raises</h4>
<li>RequestException: If the request fails with any 400 response or any other reason.</li>
</ul>

<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">106</span>
<details class="quote">
<summary>Source code in <code>dvc_studio_client/auth.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">106</span>
<span class="normal">107</span>
<span class="normal">108</span>
<span class="normal">109</span>
Expand Down Expand Up @@ -1318,16 +1312,16 @@ <h4 id="dvc_studio_client.auth.start_device_login--raises">Raises</h4>
<span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;received response: </span><span class="si">%s</span><span class="s2"> (status=</span><span class="si">%r</span><span class="s2">)&quot;</span><span class="p">,</span> <span class="n">d</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">)</span>
<span class="k">return</span> <span class="n">d</span>
</code></pre></div></td></tr></table></div>
</details>
</div>
</details>
</div>

</div>



</div>

</div>
</div>

</div>

Expand Down Expand Up @@ -1394,7 +1388,7 @@ <h4 id="dvc_studio_client.auth.start_device_login--raises">Raises</h4>
<script id="__config" type="application/json">{"base": "../../..", "features": [], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
<script src="../../../assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
32 changes: 15 additions & 17 deletions reference/dvc_studio_client/config/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@


<link rel="icon" href="../../../assets/logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.21">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">



<title>Config - dvc-studio-client</title>



<link rel="stylesheet" href="../../../assets/stylesheets/main.66ac8b77.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/main.6543a935.min.css">


<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
Expand Down Expand Up @@ -144,7 +144,7 @@

</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
Expand Down Expand Up @@ -610,12 +610,11 @@ <h1>Config</h1>


<a id="dvc_studio_client.config"></a>
<div class="doc doc-contents first">
<div class="doc doc-contents first">



<div class="doc doc-children">

<div class="doc doc-children">



Expand All @@ -628,15 +627,14 @@ <h1>Config</h1>
<div class="doc doc-object doc-function">



<h2 id="dvc_studio_client.config.get_studio_config" class="doc doc-heading">
<code class="highlight language-python"><span class="n">get_studio_config</span><span class="p">(</span><span class="n">dvc_studio_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">offline</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">studio_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">studio_repo_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">studio_url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
<code class="highlight language-python"><span class="n">get_studio_config</span><span class="p">(</span><span class="n">dvc_studio_config</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">offline</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">studio_token</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">studio_repo_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">studio_url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>

</h2>


<div class="doc doc-contents ">
<div class="doc doc-contents ">

<p>Get studio config options.</p>
<hr />
<pre><code>dvc_studio_config (Optional[dict]): Dict returned by dvc.Repo.config["studio"].
Expand All @@ -659,9 +657,9 @@ <h4 id="dvc_studio_client.config.get_studio_config--example">Example:</h4>
}
</code></pre>

<details class="quote">
<summary>Source code in <code>dvc_studio_client/config.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 49</span>
<details class="quote">
<summary>Source code in <code>dvc_studio_client/config.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"> 49</span>
<span class="normal"> 50</span>
<span class="normal"> 51</span>
<span class="normal"> 52</span>
Expand Down Expand Up @@ -841,16 +839,16 @@ <h4 id="dvc_studio_client.config.get_studio_config--example">Example:</h4>

<span class="k">return</span> <span class="n">config</span>
</code></pre></div></td></tr></table></div>
</details>
</div>
</details>
</div>

</div>



</div>

</div>
</div>

</div>

Expand Down Expand Up @@ -917,7 +915,7 @@ <h4 id="dvc_studio_client.config.get_studio_config--example">Example:</h4>
<script id="__config" type="application/json">{"base": "../../..", "features": [], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../../../assets/javascripts/bundle.a7c05c9e.min.js"></script>
<script src="../../../assets/javascripts/bundle.ad660dcc.min.js"></script>


</body>
Expand Down
Loading

0 comments on commit 1f99a2c

Please sign in to comment.