Skip to content

Commit 9a754ad

Browse files
authored
Fix syntax for Docs Build Workflow (open-telemetry#1392)
1 parent 3b813eb commit 9a754ad

File tree

3 files changed

+23
-26
lines changed

3 files changed

+23
-26
lines changed

.github/workflows/docs.yml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,24 @@ jobs:
1717
docs:
1818
runs-on: ubuntu-latest
1919
steps:
20-
- uses: actions/checkout@v2
21-
- name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
20+
- uses: actions/checkout@v2
21+
- name: Checkout Contrib Repo @ SHA - ${{ env.CONTRIB_REPO_SHA }}
2222
uses: actions/checkout@v2
2323
with:
2424
repository: open-telemetry/opentelemetry-python-contrib
2525
ref: ${{ env.CONTRIB_REPO_SHA }}
2626
path: opentelemetry-python-contrib
27-
- name: Set up Python py38
28-
uses: actions/setup-python@v2
29-
with:
30-
python-version: '3.8'
31-
- name: Build docs
32-
run: |
33-
pip install --upgrade tox
34-
tox -e docs
35-
- name: Publish to gh-pages
36-
uses: JamesIves/github-pages-deploy-action@2.0.2
37-
env:
38-
ACCESS_TOKEN: ${{ secrets.DocsPushToken }}
39-
BRANCH: gh-pages
40-
FOLDER: docs/_build/html/
27+
- name: Set up Python py38
28+
uses: actions/setup-python@v2
29+
with:
30+
python-version: '3.8'
31+
- name: Build docs
32+
run: |
33+
pip install --upgrade tox
34+
tox -e docs
35+
- name: Publish to gh-pages
36+
uses: JamesIves/github-pages-deploy-action@2.0.2
37+
env:
38+
ACCESS_TOKEN: ${{ secrets.DocsPushToken }}
39+
BRANCH: gh-pages
40+
FOLDER: docs/_build/html/

docs-requirements.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ sphinx-autodoc-typehints~=1.10.2
66
# doesn't work for pkg_resources.
77
./opentelemetry-api
88
./opentelemetry-sdk
9+
./opentelemetry-python-contrib/exporter/opentelemetry-exporter-datadog
10+
./opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-grpc
11+
./opentelemetry-instrumentation
12+
./opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-requests
13+
./opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-wsgi
14+
./opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-django
15+
./opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-flask
916

1017
# Required by ext packages
1118
asgiref~=3.0

tox.ini

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -154,19 +154,9 @@ commands =
154154

155155
[testenv:docs]
156156
deps =
157-
-e {toxinidir}/opentelemetry-python-contrib/exporter/opentelemetry-exporter-datadog
158-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-grpc
159-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-flask
160-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-django
161-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-requests
162-
-e {toxinidir}/opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-wsgi
163157
-c {toxinidir}/dev-requirements.txt
164158
-r {toxinidir}/docs-requirements.txt
165159

166-
commands_pre =
167-
pip install -e {toxinidir}/opentelemetry-api \
168-
-e {toxinidir}/opentelemetry-sdk
169-
170160
changedir = docs
171161

172162
commands =

0 commit comments

Comments
 (0)