opentelemetry-python icon indicating copy to clipboard operation
opentelemetry-python copied to clipboard

Some documentation not built into sphinx docs

Open aabmass opened this issue 3 years ago • 6 comments

There is a good amount of docstring/API documentation missing from our sphinx builds. For example opentelemetry.propagate classes/functions and docstrings are not available on ReadTheDocs. The same is true of many metrics modules.

To fix this, someone has to write RST files to point automodule at the python modules we want built into the docs.

This manual step is error prone, so it would be great if it could be automated away in addition to fixing the docs.

aabmass avatar Mar 28 '22 20:03 aabmass

related issue #1678

srikanthccv avatar Mar 29 '22 04:03 srikanthccv

Yes! Automating this is a great idea :sunglasses:

ocelotl avatar Mar 30 '22 00:03 ocelotl