Skip to content

Commit b38d4d2

Browse files
docs: fix readthedocs build [backport 2.3] (#7719)
Backport 62db3a9 from #7700 to 2.3. Resolves: #7606 Resolves circular imports by avoiding patching and tracing sphynx imports. Note - We do not have test coverage for generating docs. I verified this change locally by running: `hatch -v run docs:sphinx-build -W -b html docs docs/_build/html` ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that. Co-authored-by: Munir Abdinur <[email protected]>
1 parent 80f3264 commit b38d4d2

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

hatch.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ extra-dependencies = [
8484
pre-install-commands = [
8585
"scripts/docs/install.sh",
8686
]
87+
[envs.docs.env-vars]
88+
DD_TRACE_ENABLED = "false"
8789

8890
[envs.docs.scripts]
8991
build = [

scripts/docs/build.sh

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
#!/usr/bin/env bash
2-
3-
export DD_TRACE_ENABLED=0
4-
52
set -eux
63

74
reno lint

0 commit comments

Comments
 (0)