Problem Statement

Our API docs are in desperate need of some love, e.g.:

• some stuff is not documented at all
  • no docs for the tracing module (spans, transactions)
  • only Logging under Integrations, no other integrations
• some of the top level API docs only mention **kwargs without any further explanation, so people have to dive into the code themselves (Top-level API should list possible args/kwargs explicitly #2199) Allow (some) autocompletion for top-level API #2213
• there's some annoying overlapping happening at times:
  

Solution Brainstorm

• See what relevant parts are undocumented and add them.
• Find an alternative theme where things don't overlap. Change API doc theme #2210
• Make a general effort to improve existing docstrings.
• Add more docstrings where it makes sense.

See also:

• Document scope_kwargs on capture_message  #1086
• tracing.py is not included in https://getsentry.github.io/sentry-python/ #1708
• Top-level API should list possible args/kwargs explicitly #2199