Remove unnecesary contrib packages from docs install#1470
Remove unnecesary contrib packages from docs install#1470codeboten merged 1 commit intoopen-telemetry:masterfrom
Conversation
|
Wasn't this the fix for the original docs build failing in the first place? |
|
@lzchen Originally the docs were failing because it couldn’t find a clone of the Contrib repo in its root directory (we made that during the GitHub action workflow but not this one). So the earlier fix downloaded them from Git instead of installing a local version of the package. But turns out all references to Contrib packages are in code examples not documented code. |
3abecd4 to
4796f7c
Compare
|
@NathanielRN |
862745f to
c552011
Compare
c552011 to
7ff0509
Compare
|
We didn't have to remove them, the Contrib examples are still here in Core as referenced in Getting Started and as found in the docs/examples/ folder. I think we just assumed that we needed to download the instrumentations for these examples, but because these examples aren't getting auto-documented themselves (they're just being pointed to as files), they don't need to be referenced explicitly. |
98ee252 to
7ff0509
Compare
Description
As a follow up to #1464 I found that the docs tests pass just fine if there these packages are not installed.
Making this PR to mostly ask questions if anyone knows why these were needed!
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
tox -e docspasses and the sphinx build is created without a problem.Does This PR Require a Contrib Repo Change?
Checklist:
- [ ] Changelogs have been updated- [ ] Unit tests have been added- [ ] Documentation has been updated