-
Notifications
You must be signed in to change notification settings - Fork 657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for supported environment variables #1147
Comments
The sphinx envvar role seems to work pretty well, I used it for opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/resources/__init__.py Lines 56 to 64 in 2b46d11
And here's how it shows in the docs: https://opentelemetry-python.readthedocs.io/en/latest/sdk/resources.html#envvar-OTEL_RESOURCE_ATTRIBUTES |
* ci: add markdown linting Signed-off-by: Naseem <[email protected]> * fix: lint markdown files Signed-off-by: Naseem <[email protected]> * docs: add markdown lint configuration Signed-off-by: Naseem <[email protected]> * docs: lint change log Signed-off-by: Naseem <[email protected]>
This is where they should show up https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html, missing docstrings for this though. |
#1680 added docstrings. The remaining work is filling in the docstrings with missing details. I'm unassigning myself and someone else can flesh those out if I don't get to it |
Renaming this as the work left here is to document supported variables. |
This issue was marked stale due to lack of activity. It will be closed in 30 days. |
Hello, I would like to work on this and add some documentation to the environment variables. |
More and more environment variables are being supported by this project. It would be a good idea to figure out how to keep them organized and documented in a single place where users can easily find documentation for the supported environment variables.
The text was updated successfully, but these errors were encountered: