craft(gh-pages): update, version "1.32.0"

getsentry · Oct 11, 2023 · 1609e74 · 1609e74
1 parent ae65ecb
commit 1609e74
Show file tree

Hide file tree

Showing 34 changed files with 8,267 additions and 4,962 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -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: 3338c4e2bb4a489d035491997ae68c02
+config: d08fc56c80e778f04cc396007995ac82
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/apidocs.doctree b/.doctrees/apidocs.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/integrations.doctree b/.doctrees/integrations.doctree
diff --git a/_modules/index.html b/_modules/index.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-      <title>Overview: module code - sentry-python 1.31.0 documentation</title>
+      <title>Overview: module code - sentry-python 1.32.0 documentation</title>
     <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
   <script>
     const isDarkTheme = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
@@ -90,8 +90,9 @@
     <div class="sy-lside-inner md:sticky">
       <div class="sy-scrollbar p-6">
         <div class="globaltoc" data-expand-depth="0"><ul>
-<li class="toctree-l1"><a class="reference internal" href="../api.html">Main API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../api.html">Top Level API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../integrations.html">Integrations</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../apidocs.html">API Docs</a></li>
 </ul>
 
         </div>
@@ -138,10 +139,16 @@
         <article class="yue" role="main">
           <h1>All modules for which code is available</h1>
 <ul><li><a href="sentry_sdk/api.html">sentry_sdk.api</a></li>
+<li><a href="sentry_sdk/attachments.html">sentry_sdk.attachments</a></li>
 <li><a href="sentry_sdk/client.html">sentry_sdk.client</a></li>
+<li><a href="sentry_sdk/envelope.html">sentry_sdk.envelope</a></li>
 <li><a href="sentry_sdk/hub.html">sentry_sdk.hub</a></li>
 <li><a href="sentry_sdk/integrations/logging.html">sentry_sdk.integrations.logging</a></li>
+<li><a href="sentry_sdk/monitor.html">sentry_sdk.monitor</a></li>
+<li><a href="sentry_sdk/profiler.html">sentry_sdk.profiler</a></li>
 <li><a href="sentry_sdk/scope.html">sentry_sdk.scope</a></li>
+<li><a href="sentry_sdk/scrubber.html">sentry_sdk.scrubber</a></li>
+<li><a href="sentry_sdk/session.html">sentry_sdk.session</a></li>
 <li><a href="sentry_sdk/tracing.html">sentry_sdk.tracing</a></li>
 <li><a href="sentry_sdk/transport.html">sentry_sdk.transport</a></li>
 </ul>
@@ -176,7 +183,7 @@ <h1>All modules for which code is available</h1>
     </div>
   </div>
 </footer></div>
-      <script src="../_static/documentation_options.js?v=497d83b4"></script>
+      <script src="../_static/documentation_options.js?v=db025d5f"></script>
       <script src="../_static/doctools.js?v=888ff710"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
       <script src="../_static/shibuya.js?v=3e5c8598"></script>

diff --git a/_modules/sentry_sdk/api.html b/_modules/sentry_sdk/api.html
diff --git a/_modules/sentry_sdk/attachments.html b/_modules/sentry_sdk/attachments.html
diff --git a/_modules/sentry_sdk/client.html b/_modules/sentry_sdk/client.html
diff --git a/_modules/sentry_sdk/envelope.html b/_modules/sentry_sdk/envelope.html
diff --git a/_modules/sentry_sdk/hub.html b/_modules/sentry_sdk/hub.html
diff --git a/_modules/sentry_sdk/integrations/logging.html b/_modules/sentry_sdk/integrations/logging.html
diff --git a/_modules/sentry_sdk/monitor.html b/_modules/sentry_sdk/monitor.html
diff --git a/_modules/sentry_sdk/profiler.html b/_modules/sentry_sdk/profiler.html
diff --git a/_modules/sentry_sdk/scope.html b/_modules/sentry_sdk/scope.html
diff --git a/_modules/sentry_sdk/scrubber.html b/_modules/sentry_sdk/scrubber.html
diff --git a/_modules/sentry_sdk/session.html b/_modules/sentry_sdk/session.html
diff --git a/_modules/sentry_sdk/tracing.html b/_modules/sentry_sdk/tracing.html
diff --git a/_modules/sentry_sdk/transport.html b/_modules/sentry_sdk/transport.html
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -1,15 +1,53 @@
-========
-Main API
-========
+=============
+Top Level API
+=============
 
-.. inherited-members necessary because of hack for Client and init methods
+This is the user facing API of the SDK. It's exposed as ``sentry_sdk``.
+With this API you can implement a custom performance monitoring or error reporting solution.
 
-.. automodule:: sentry_sdk
-    :members:
-    :inherited-members:
 
-.. autoclass:: sentry_sdk.tracing.Span
-   :members:
+Capturing Data
+==============
 
-.. autoclass:: sentry_sdk.tracing.Transaction
-   :members:
+.. autofunction:: sentry_sdk.api.capture_event
+.. autofunction:: sentry_sdk.api.capture_exception
+.. autofunction:: sentry_sdk.api.capture_message
+
+
+Enriching Events
+================
+
+.. autofunction:: sentry_sdk.api.add_breadcrumb
+.. autofunction:: sentry_sdk.api.set_context
+.. autofunction:: sentry_sdk.api.set_extra
+.. autofunction:: sentry_sdk.api.set_level
+.. autofunction:: sentry_sdk.api.set_tag
+.. autofunction:: sentry_sdk.api.set_user
+
+
+Performance Monitoring
+======================
+
+.. autofunction:: sentry_sdk.api.continue_trace
+.. autofunction:: sentry_sdk.api.get_current_span
+.. autofunction:: sentry_sdk.api.start_span
+.. autofunction:: sentry_sdk.api.start_transaction
+
+
+Distributed Tracing
+===================
+
+.. autofunction:: sentry_sdk.api.get_baggage
+.. autofunction:: sentry_sdk.api.get_traceparent
+
+
+Managing Scope (advanced)
+=========================
+
+.. autofunction:: sentry_sdk.api.configure_scope
+.. autofunction:: sentry_sdk.api.push_scope
+
+
+.. Not documented (On purpose. Not sure if anyone should use those)
+.. last_event_id()
+.. flush()
diff --git a/_sources/apidocs.rst.txt b/_sources/apidocs.rst.txt
@@ -0,0 +1,45 @@
+========
+API Docs
+========
+
+.. autoclass:: sentry_sdk.Hub
+    :members:
+
+.. autoclass:: sentry_sdk.Scope
+    :members:
+
+.. autoclass:: sentry_sdk.Client
+    :members:
+
+.. autoclass:: sentry_sdk.Transport
+    :members:
+
+.. autoclass:: sentry_sdk.HttpTransport
+    :members:
+
+.. autoclass:: sentry_sdk.tracing.Transaction
+   :members:
+
+.. autoclass:: sentry_sdk.tracing.Span
+   :members:
+
+.. autoclass:: sentry_sdk.profiler.Profile
+   :members:
+
+.. autoclass:: sentry_sdk.session.Session
+   :members:
+
+.. autoclass:: sentry_sdk.attachments.Attachment
+   :members:
+
+.. autoclass:: sentry_sdk.scrubber.EventScrubber
+   :members:
+
+.. autoclass:: sentry_sdk.monitor.Monitor
+   :members:
+
+.. autoclass:: sentry_sdk.envelope.Envelope
+   :members:
+
+.. autoclass:: sentry_sdk.envelope.Item
+   :members:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -9,3 +9,4 @@ visit the `GitHub repository <https://github.com/getsentry/sentry-python>`_.
 .. toctree::
     api
     integrations
+    apidocs
diff --git a/_sources/integrations.rst.txt b/_sources/integrations.rst.txt
@@ -2,6 +2,8 @@
 Integrations
 ============
 
+TBD
+
 Logging
 =======
 

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.31.0',
+    VERSION: '1.32.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',
-Original file line number
+Diff line change
@@ Expand Up @@
     .. toctree::
         api
         integrations
+        apidocs