Skip to content

Commit

Permalink
docs: add missing autodoc for click and aiohttp-server (open-telemetr…
Browse files Browse the repository at this point in the history
…y#3060)

* add missing docs for click and aiohttp-server

Signed-off-by: emdneto <[email protected]>

* fix click readme

Signed-off-by: emdneto <[email protected]>

* add nitpick

Signed-off-by: emdneto <[email protected]>

---------

Signed-off-by: emdneto <[email protected]>
Co-authored-by: Riccardo Magliocchetti <[email protected]>
  • Loading branch information
emdneto and xrmx authored Dec 3, 2024
1 parent 0da62aa commit 668cb75
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/instrumentation/aiohttp_server/aiohttp_server.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. include:: ../../../instrumentation/opentelemetry-instrumentation-aiohttp-server/README.rst
:end-before: References

.. automodule:: opentelemetry.instrumentation.aiohttp_server
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/instrumentation/click/click.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. include:: ../../../instrumentation/opentelemetry-instrumentation-click/README.rst
:end-before: References

.. automodule:: opentelemetry.instrumentation.click
:members:
:undoc-members:
:show-inheritance:
3 changes: 2 additions & 1 deletion docs/nitpick-exceptions.ini
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ py-class=
httpx.SyncByteStream
httpx.AsyncByteStream
httpx.Response
aiohttp.web_request.Request
yarl.URL
cimpl.Producer
cimpl.Consumer
Expand Down Expand Up @@ -65,7 +66,7 @@ any=

py-obj=
opentelemetry.propagators.textmap.CarrierT

py-func=
poll
flush
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
OpenTelemetry click Instrumentation
===========================
====================================

|pypi|

Expand Down

0 comments on commit 668cb75

Please sign in to comment.