From 668cb75f247cdb2a620b4f4871d6a122e9d567d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Em=C3=ADdio=20Neto?= <9735060+emdneto@users.noreply.github.com> Date: Tue, 3 Dec 2024 06:19:43 -0300 Subject: [PATCH] docs: add missing autodoc for click and aiohttp-server (#3060) * add missing docs for click and aiohttp-server Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> * fix click readme Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> * add nitpick Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> --------- Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Riccardo Magliocchetti --- docs/instrumentation/aiohttp_server/aiohttp_server.rst | 7 +++++++ docs/instrumentation/click/click.rst | 7 +++++++ docs/nitpick-exceptions.ini | 3 ++- .../opentelemetry-instrumentation-click/README.rst | 2 +- 4 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 docs/instrumentation/aiohttp_server/aiohttp_server.rst create mode 100644 docs/instrumentation/click/click.rst diff --git a/docs/instrumentation/aiohttp_server/aiohttp_server.rst b/docs/instrumentation/aiohttp_server/aiohttp_server.rst new file mode 100644 index 0000000000..a4de9c4eaa --- /dev/null +++ b/docs/instrumentation/aiohttp_server/aiohttp_server.rst @@ -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: diff --git a/docs/instrumentation/click/click.rst b/docs/instrumentation/click/click.rst new file mode 100644 index 0000000000..61da603a7c --- /dev/null +++ b/docs/instrumentation/click/click.rst @@ -0,0 +1,7 @@ +.. include:: ../../../instrumentation/opentelemetry-instrumentation-click/README.rst + :end-before: References + +.. automodule:: opentelemetry.instrumentation.click + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/nitpick-exceptions.ini b/docs/nitpick-exceptions.ini index 845883fdd8..4b1b06f95b 100644 --- a/docs/nitpick-exceptions.ini +++ b/docs/nitpick-exceptions.ini @@ -29,6 +29,7 @@ py-class= httpx.SyncByteStream httpx.AsyncByteStream httpx.Response + aiohttp.web_request.Request yarl.URL cimpl.Producer cimpl.Consumer @@ -65,7 +66,7 @@ any= py-obj= opentelemetry.propagators.textmap.CarrierT - + py-func= poll flush diff --git a/instrumentation/opentelemetry-instrumentation-click/README.rst b/instrumentation/opentelemetry-instrumentation-click/README.rst index bb7ae97147..4dde08a99a 100644 --- a/instrumentation/opentelemetry-instrumentation-click/README.rst +++ b/instrumentation/opentelemetry-instrumentation-click/README.rst @@ -1,5 +1,5 @@ OpenTelemetry click Instrumentation -=========================== +==================================== |pypi|