Skip to content

docs: separate readthedocs requirements in rtd-requirements.txt to avoid conflicts during CI #3039

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Dec 3, 2024
Merged

docs: separate readthedocs requirements in rtd-requirements.txt to avoid conflicts during CI #3039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91e4e14
test two requirements files for docs and rtd
emdneto Nov 22, 2024
973d1e7
Merge branch 'main' into docs/issue-3038
emdneto Nov 26, 2024
aaaec15
Merge branch 'main' into docs/issue-3038
emdneto Nov 26, 2024
47c2589
Merge branch 'main' into docs/issue-3038
emdneto Nov 27, 2024
ae456be
Merge branch 'main' into docs/issue-3038
emdneto Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ build:

python:
install:
- requirements: docs-requirements.txt
- requirements: rtd-requirements.txt
8 changes: 0 additions & 8 deletions docs-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@ sphinx==7.1.2
sphinx-rtd-theme==2.0.0rc4
sphinx-autodoc-typehints==1.25.2

# Need to install the api/sdk in the venv for autodoc. Modifying sys.path
# doesn't work for pkg_resources.
-e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-api&subdirectory=opentelemetry-api"
-e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-semantic-conventions&subdirectory=opentelemetry-semantic-conventions"
-e "git+https://github.com/open-telemetry/opentelemetry-python.git#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk"
-e "git+https://github.com/open-telemetry/opentelemetry-python-contrib.git#egg=opentelemetry-util-http&subdirectory=util/opentelemetry-util-http"
./opentelemetry-instrumentation

# Required by opentelemetry-instrumentation
fastapi>=0.65.2
pymemcache~=1.3
Expand Down
7 changes: 7 additions & 0 deletions rtd-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Need to install the api/sdk in the venv for autodoc. Used by .readthedocs.yml
opentelemetry-api @ git+https://github.com/open-telemetry/opentelemetry-python.git@main#egg=opentelemetry-api&subdirectory=opentelemetry-api
opentelemetry-semantic-conventions @ git+https://github.com/open-telemetry/opentelemetry-python.git@main#egg=opentelemetry-semantic-conventions&subdirectory=opentelemetry-semantic-conventions
opentelemetry-sdk @ git+https://github.com/open-telemetry/opentelemetry-python.git@main#egg=opentelemetry-sdk&subdirectory=opentelemetry-sdk
./opentelemetry-instrumentation
./util/opentelemetry-util-http
-r ./docs-requirements.txt
Loading