8000 Update documentation · adamchainz/sentry-python@86b385f · GitHub
[go: up one dir, main page]
Skip to content

Commit 86b385f

Browse files
untitakeruntitaker
committed
Update documentation
1 parent d2aae3b commit 86b385f

26 files changed

+1998
-1660
lines changed

‎.doctrees/api.doctree

201 KB
Binary file not shown.

‎.doctrees/environment.pickle

10.4 KB
Binary file not shown.

‎.doctrees/index.doctree

-203 KB
Binary file not shown.

‎.doctrees/integrations.doctree

11.5 KB
Binary file not shown.

‎_modules/index.html

Lines changed: 6 additions & 1 deletion
F438
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ <h1>All modules for which code is available</h1>
3434
<ul><li><a href="sentry_sdk/api.html">sentry_sdk.api</a></li>
3535
<li><a href="sentry_sdk/client.html">sentry_sdk.client</a></li>
3636
<li><a href="sentry_sdk/hub.html">sentry_sdk.hub</a></li>
37+
<li><a href="sentry_sdk/integrations/logging.html">sentry_sdk.integrations.logging</a></li>
3738
<li><a href="sentry_sdk/scope.html">sentry_sdk.scope</a></li>
3839
<li><a href="sentry_sdk/transport.html">sentry_sdk.transport</a></li>
3940
</ul>
@@ -54,6 +55,10 @@ <h1 class="logo"><a href="../index.html">sentry-python</a></h1>
5455

5556

5657
<h3>Navigation</h3>
58+
<ul>
59+
<li class="toctree-l1"><a class="reference internal" href="../api.html">Main API</a></li>
60+
<li class="toctree-l1"><a class="reference internal" href="../integrations.html">Integrations</a></li>
61+
</ul>
5762

5863
<div class="relations">
5964
<h3>Related Topics</h3>
@@ -88,7 +93,7 @@ <h3 id="searchlabel">Quick search</h3>
8893
&copy;2019, Sentry Team and Contributors.
8994

9095
|
91-
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
96+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.0+/296b1bf</a>
9297
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
9398

9499
</div>

‎_modules/sentry_sdk/api.html

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
8181
<span class="k">return</span> <span class="n">f</span>
8282

8383

84-
<div class="viewcode-block" id="capture_event"><a class="viewcode-back" href="../../index.html#sentry_sdk.capture_event">[docs]</a><span class="nd">@hubmethod</span>
84+
<div class="viewcode-block" id="capture_event"><a class="viewcode-back" href="../../api.html#sentry_sdk.capture_event">[docs]</a><span class="nd">@hubmethod</span>
8585
<span class="k">def</span> <span class="nf">capture_event</span><span class="p">(</span>
8686
<span class="n">event</span><span class="p">,</span> <span class="c1"># type: Event</span>
8787
<span class="n">hint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Hint]</span>
@@ -93,7 +93,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
9393
<span class="k">return</span> <span class="kc">None</span></div>
9494

9595

96-
<div class="viewcode-block" id="capture_message"><a class="viewcode-back" href="../../index.html#sentry_sdk.capture_message">[docs]</a><span class="nd">@hubmethod</span>
96+
<div class="viewcode-block" id="capture_message"><a class="viewcode-back" href="../../api.html#sentry_sdk.capture_message">[docs]</a><span class="nd">@hubmethod</span>
9797
<span class="k">def</span> <span class="nf">capture_message</span><span class="p">(</span>
9898
<span class="n">message</span><span class="p">,</span> <span class="c1"># type: str</span>
9999
<span class="n">level</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[str]</span>
@@ -105,7 +105,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
105105
<span class="k">return</span> <span class="kc">None</span></div>
106106

107107

108-
<div class="viewcode-block" id="capture_exception"><a class="viewcode-back" href="../../index.html#sentry_sdk.capture_exception">[docs]</a><span class="nd">@hubmethod</span>
108+
<div class="viewcode-block" id="capture_exception"><a class="viewcode-back" href="../../api.html#sentry_sdk.capture_exception">[docs]</a><span class="nd">@hubmethod</span>
109109
<span class="k">def</span> <span class="nf">capture_exception</span><span class="p">(</span>
110110
<span class="n">error</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># type: Optional[BaseException]</span>
111111
<span class="p">):</span>
@@ -116,7 +116,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
116116
<span class="k">return</span> <span class="kc">None</span></div>
117117

118118

119-
<div class="viewcode-block" id="add_breadcrumb"><a class="viewcode-back" href="../../index.html#sentry_sdk.add_breadcrumb">[docs]</a><span class="nd">@hubmethod</span>
119+
<div class="viewcode-block" id="add_breadcrumb"><a class="viewcode-back" href="../../api.html#sentry_sdk.add_breadcrumb">[docs]</a><span class="nd">@hubmethod</span>
120120
<span class="k">def</span> <span class="nf">add_breadcrumb</span><span class="p">(</span>
121121
<span class="n">crumb</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Breadcrumb]</span>
122122
<span class="n">hint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[BreadcrumbHint]</span>
@@ -142,7 +142,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
142142
<span class="k">pass</span>
143143

144144

145-
<div class="viewcode-block" id="configure_scope"><a class="viewcode-back" href="../../index.html#sentry_sdk.configure_scope">[docs]</a><span class="nd">@hubmethod</span> <span class="c1"># noqa</span>
145+
<div class="viewcode-block" id="configure_scope"><a class="viewcode-back" href="../../api.html#sentry_sdk.configure_scope">[docs]</a><span class="nd">@hubmethod</span> <span class="c1"># noqa</span>
146146
<span class="k">def</span> <span class="nf">configure_scope</span><span class="p">(</span>
147147
<span class="n">callback</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># type: Optional[Callable[[Scope], None]]</span>
148148
<span class="p">):</span>
@@ -176,7 +176,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
176176
<span class="k">pass</span>
177177

178178

179-
<div class="viewcode-block" id="push_scope"><a class="viewcode-back" href="../../index.html#sentry_sdk.push_scope">[docs]</a><span class="nd">@hubmethod</span> <span class="c1"># noqa</span>
179+
<div class="viewcode-block" id="push_scope"><a class="viewcode-back" href="../../api.html#sentry_sdk.push_scope">[docs]</a><span class="nd">@hubmethod</span> <span class="c1"># noqa</span>
180180
<span class="k">def</span> <span class="nf">push_scope</span><span class="p">(</span>
181181
<span class="n">callback</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># type: Optional[Callable[[Scope], None]]</span>
182182
<span class="p">):</span>
@@ -196,7 +196,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
196196
<span class="k">return</span> <span class="kc">None</span></div>
197197

198198

199-
<div class="viewcode-block" id="flush"><a class="viewcode-back" href="../../index.html#sentry_sdk.flush">[docs]</a><span class="nd">@hubmethod</span>
199+
<div class="viewcode-block" id="flush"><a class="viewcode-back" href="../../api.html#sentry_sdk.flush">[docs]</a><span class="nd">@hubmethod</span>
200200
<span class="k">def</span> <span class="nf">flush</span><span class="p">(</span>
201201
<span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[float]</span>
202202
<span class="n">callback</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Callable[[int, float], None]]</span>
@@ -207,7 +207,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
207207
<span class="k">return</span> <span class="n">hub</span><span class="o">.</span><span class="n">flush</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span> <span class="n">callback</span><span class="o">=</span><span class="n">callback</span><span class="p">)</span></div>
208208

209209

210-
<div class="viewcode-block" id="last_event_id"><a class="viewcode-back" href="../../index.html#sentry_sdk.last_event_id">[docs]</a><span class="nd">@hubmethod</span>
210+
<div class="viewcode-block" id="last_event_id"><a class="viewcode-back" href="../../api.html#sentry_sdk.last_event_id">[docs]</a><span class="nd">@hubmethod</span>
211211
<span class="k">def</span> <span class="nf">last_event_id</span><span class="p">():</span>
212212
<span class="c1"># type: () -&gt; Optional[str]</span>
213213
<span class="n">hub</span> <span class="o">=</span> <span class="n">Hub</span><span class="o">.</span><span class="n">current</span>
@@ -216,7 +216,7 @@ <h1>Source code for sentry_sdk.api</h1><div class="highlight"><pre>
216216
<span class="k">return</span> <span class="kc">None</span></div>
217217

218218

219-
<div class="viewcode-block" id="start_span"><a class="viewcode-back" href="../../index.html#sentry_sdk.start_span">[docs]</a><span class="nd">@hubmethod</span>
219+
<div class="viewcode-block" id="start_span"><a class="viewcode-back" href="../../api.html#sentry_sdk.start_span">[docs]</a><span class="nd">@hubmethod</span>
220220
<span class="k">def</span> <span class="nf">start_span</span><span class="p">(</span>
221221
<span class="n">span</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="c1"># type: Optional[Span]</span>
222222
<span class="o">**</span><span class="n">kwargs</span> <span class="c1"># type: Any</span>
@@ -244,6 +244,10 @@ <h1 class="logo"><a href="../../index.html">sentry-python</a></h1>
244244

245245

246246
<h3>Navigation</h3>
247+
<ul>
248+
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Main API</a></li>
249+
<li class="toctree-l1"><a class="reference internal" href="../../integrations.html">Integrations</a></li>
250+
</ul>
247251

248252
<div class="relations">
249253
<h3>Related Topics</h3>
@@ -280,7 +284,7 @@ <h3 id="searchlabel">Quick search</h3>
280284
&copy;2019, Sentry Team and Contributors.
281285

282286
|
283-
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
287+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.0+/296b1bf</a>
284288
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
285289

286290
</div>

‎_modules/sentry_sdk/client.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ <h1>Source code for sentry_sdk.client</h1><div class="highlight"><pre>
352352
<span class="k">class</span> <span class="nc">get_options</span><span class="p">(</span><span class="n">ClientConstructor</span><span class="p">,</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]):</span>
353353
<span class="k">pass</span>
354354

355-
<div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../index.html#sentry_sdk.Client">[docs]</a> <span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="n">ClientConstructor</span><span class="p">,</span> <span class="n">_Client</span><span class="p">):</span>
355+
<div class="viewcode-block" id="Client"><a class="viewcode-back" href="../../api.html#sentry_sdk.Client">[docs]</a> <span class="k">class</span> <span class="nc">Client</span><span class="p">(</span><span class="n">ClientConstructor</span><span class="p">,</span> <span class="n">_Client</span><span class="p">):</span>
356356
<span class="k">pass</span></div>
357357

358358

@@ -382,6 +382,10 @@ <h1 class="logo"><a href="../../index.html">sentry-python</a></h1>
382382

383383

384384
<h3>Navigation</h3>
385+
<ul>
386+
<li class="toctree-l1"><a class="reference internal" href="../../api.html">Main API</a></li>
387+
<li class="toctree-l1"><a class="reference internal" href="../../integrations.html">Integrations</a></li>
388+
</ul>
385389

386390
<div class="relations">
387391
<h3>Related Topics</h3>
@@ -418,7 +422,7 @@ <h3 id="searchlabel">Quick search</h3>
418422
&copy;2019, Sentry Team and Contributors.
419423

420424
|
421-
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.2.0</a>
425+
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.0.0+/296b1bf</a>
422426
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
423427

424428
</div>

0 commit comments

Comments
 (0)
0