Conversation
docs/opentelemetry.api.rst
Outdated
| --------------- | ||
|
|
||
| .. automodule:: opentelemetry.api | ||
| :members: |
There was a problem hiding this comment.
Since these options seem to be the same everywhere, they should be added to the configuration https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
Co-Authored-By: Christian Neumüller <cn00@gmx.at>
…n into tracer-api-init
|
I updated the |
and remove generated API docs other than opencensus.trace.
|
I update the docs for the package move in #21 and removed a lot of the generated API doc boilerplate. After the package move autodoc generates empty docs for the new empty packages from #19, I removed these by hand. I also moved the |
Carry the final autoresearch tree as one reviewable change that includes the trace benchmark harness, SDK trace hot-path reductions, empty-context activation fast path, direct BoundedAttributes initialization, and focused validation updates. Experiments: open-telemetry#4, open-telemetry#5, open-telemetry#6, open-telemetry#7, open-telemetry#8, open-telemetry#9, open-telemetry#10, open-telemetry#11, open-telemetry#12, open-telemetry#14, open-telemetry#15, open-telemetry#16, open-telemetry#17, open-telemetry#18, open-telemetry#19 Metric: combined_mean_us 44.469470µs → 22.762846µs (-48.8%)




This PR adds sphinx boilerplate for generating API docs. Most files are generated with
sphinx-quickstartandsphinx-apidocwith few changes.This branch builds on #11, I'll rebase as it's updated.
You can build the html docs from this branch as:
pip install sphinx sphinx_autodoc_typehints sphinx_rtd_theme sphinx-quickstart sphinx-apidoc --force -e -o docs opentelemetry (cd docs; make html)I also pushed the generated html docs to the
sphinx-docs-builtbranch, which you can check out to view the docs without building them yourself.