Consolidate instrumentation documentation in docstrings

[lzchen]

Updates instrumentation docstrings to include section on configuration. Most are related to exclude_url functionality and request/response hooks. We want all of our documentation to exist in one place (readthedocs).

[codeboten]

Was there a decision made to add the documentation here? Is this duplicating existing documentation?

[lzchen]

@codeboten
I believe configuration options for instrumentations either exist in the README or in the docstrings of the instrumentation. We should choose one place and be consistent. Only choosing README in this PR because it seemed easier to find (from some feedback) but I don't have a strong opinion. Thoughts?

[owais]

Will removing docstrings mean removing the docs from readthedocs?

Read the description again. 👍 for keeping read the docs. We could also have our 4th generate script that allows us to keep docstrings as the single source of truth and generate everything else from that but this is fine as well as long as readthedocs contains the docs.

[codeboten]

Just confirming this is moving all the documentation that would have ended up on pypi into the read the docs repo correct? Users should be able to access it via the links in each package.

[lzchen]

@codeboten

Just confirming this is moving all the documentation that would have ended up on pypi into the read the docs repo correct? Users should be able to access it via the links in each package.

Correct.

[codeboten]

Sounds good, looks like a few things need fixing, otherwise the change looks great.

[lzchen]

@owais

We could also have our 4th generate script that allows us to keep docstrings as the single source of truth and generate everything else from that but this is fine as well as long as readthedocs contains the docs.

Haha so many generate scripts xD

[codeboten]

@owais

We could also have our 4th generate script that allows us to keep docstrings as the single source of truth and generate everything else from that but this is fine as well as long as readthedocs contains the docs.

Haha so many generate scripts xD

Soon we'll generate scripts via a generate script

.