Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
isaackogan committed Dec 15, 2024
1 parent b333a85 commit 6842b92
Show file tree
Hide file tree
Showing 34 changed files with 562 additions and 524 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0ec8d95a2e7ae4ab1ded3d7ec876bcdc
config: 01687ca540b69cc66f4683f5e09e28bd
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 3 additions & 3 deletions docs/TikTokLive.client.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client.web package" href="TikTokLive.client.web.html" /><link rel="prev" title="TikTokLive package" href="TikTokLive.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client package - TikTokLive v6.2.0</title>
<title>TikTokLive.client package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
7 changes: 4 additions & 3 deletions docs/TikTokLive.client.web.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client.web.routes package" href="TikTokLive.client.web.routes.html" /><link rel="prev" title="TikTokLive.client package" href="TikTokLive.client.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client.web package - TikTokLive v6.2.0</title>
<title>TikTokLive.client.web package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -343,6 +343,7 @@ <h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this hea
</li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.web.routes.html#TikTokLive.client.web.routes.sign_fetch.SignFetchRoute"><code class="docutils literal notranslate"><span class="pre">SignFetchRoute</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="TikTokLive.client.web.routes.html#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.routes.html#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.format_sign_server_message"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.format_sign_server_message()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.routes.html#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.reset_time"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.reset_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="TikTokLive.client.web.routes.html#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.retry_after"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.retry_after</span></code></a></li>
</ul>
Expand Down
15 changes: 11 additions & 4 deletions docs/TikTokLive.client.web.routes.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client.ws package" href="TikTokLive.client.ws.html" /><link rel="prev" title="TikTokLive.client.web package" href="TikTokLive.client.web.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client.web.routes package - TikTokLive v6.2.0</title>
<title>TikTokLive.client.web.routes package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -633,9 +633,15 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi

<dl class="py exception">
<dt class="sig sig-object py" id="TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.web.routes.sign_fetch.</span></span><span class="sig-name descname"><span class="pre">SignatureRateLimitError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">retry_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError" title="Link to this definition"></a></dt>
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">TikTokLive.client.web.routes.sign_fetch.</span></span><span class="sig-name descname"><span class="pre">SignatureRateLimitError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">retry_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reset_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">api_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignAPIError" title="TikTokLive.client.web.routes.sign_fetch.SignAPIError"><code class="xref py py-class docutils literal notranslate"><span class="pre">SignAPIError</span></code></a></p>
<p>Thrown when a user hits the Sign API limit</p>
<dl class="py method">
<dt class="sig sig-object py" id="TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.format_sign_server_message">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_sign_server_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.format_sign_server_message" title="Link to this definition"></a></dt>
<dd><p>Format the sign server message</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.reset_time">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_time</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.reset_time" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -794,6 +800,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
</li>
<li><a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignFetchRoute"><code class="docutils literal notranslate"><span class="pre">SignFetchRoute</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError</span></code></a><ul>
<li><a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.format_sign_server_message"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.format_sign_server_message()</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.reset_time"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.reset_time</span></code></a></li>
<li><a class="reference internal" href="#TikTokLive.client.web.routes.sign_fetch.SignatureRateLimitError.retry_after"><code class="docutils literal notranslate"><span class="pre">SignatureRateLimitError.retry_after</span></code></a></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/TikTokLive.client.ws.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.events package" href="TikTokLive.events.html" /><link rel="prev" title="TikTokLive.client.web.routes package" href="TikTokLive.client.web.routes.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.client.ws package - TikTokLive v6.2.0</title>
<title>TikTokLive.client.ws package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
6 changes: 3 additions & 3 deletions docs/TikTokLive.events.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.proto package" href="TikTokLive.proto.html" /><link rel="prev" title="TikTokLive.client.ws package" href="TikTokLive.client.ws.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive.events package - TikTokLive v6.2.0</title>
<title>TikTokLive.events package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
6 changes: 3 additions & 3 deletions docs/TikTokLive.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="TikTokLive.client package" href="TikTokLive.client.html" /><link rel="prev" title="TikTokLive Docs" href="index.html" />

<!-- Generated with Sphinx 7.4.7 and Furo 2024.08.06 -->
<title>TikTokLive package - TikTokLive v6.2.0</title>
<title>TikTokLive package - TikTokLive v6.2.1.post1</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=354aac6f" />
<link rel="stylesheet" type="text/css" href="_static/css/rtd_sphinx_search.min.css?v=e72958e9" />
Expand Down Expand Up @@ -172,7 +172,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">TikTokLive v6.2.0</div></a>
<a href="index.html"><div class="brand">TikTokLive v6.2.1.post1</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -199,7 +199,7 @@
<img class="sidebar-logo" src="_static/logo.png" alt="Logo"/>
</div>

<span class="sidebar-brand-text">TikTokLive v6.2.0</span>
<span class="sidebar-brand-text">TikTokLive v6.2.1.post1</span>

</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down
Loading

0 comments on commit 6842b92

Please sign in to comment.