Skip to content

Commit 08789c3

Browse files
committed
Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
1 parent f019e4a commit 08789c3

File tree

4 files changed

+60
-2
lines changed

4 files changed

+60
-2
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build HTML Docs
2+
on:
3+
pull_request:
4+
types: [opened, reopened, synchronize, edited]
5+
jobs:
6+
tox-docs:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: opentelekomcloud-infra/github-actions/.github/actions/tox-run-env@v1
10+
with:
11+
tox-env: docs
12+
13+
- name: Upload documentation preview
14+
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
15+
uses: opentelekomcloud-infra/github-actions/.github/actions/tox-upload-swift@v1
16+
with:
17+
docs_path: "doc/build/html"
18+
docs_service: regions-and-endpoints
19+
swift_container: "gh_action_logs"
20+
otc_swift_username: ${{ secrets.OTC_SWIFT_USERNAME }}
21+
otc_swift_password: ${{ secrets.OTC_SWIFT_PASSWORD }}
22+
otc_swift_project_name: ${{ secrets.OTC_SWIFT_PROJECT_NAME }}
23+
otc_swift_domain: ${{ secrets.OTC_SWIFT_DOMAIN }}
24+
otc_swift_endpoint: ${{ secrets.OTC_SWIFT_ENDPOINT }}
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
repo: ${{ github.repository }}
27+
pr_number: ${{ github.event.pull_request.number }}
28+
run_id: ${{ github.run_id }}
29+
ci_platform: github
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build PDF Docs
2+
on:
3+
pull_request:
4+
types: [opened, reopened, synchronize, edited]
5+
jobs:
6+
tox-pdf-docs:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: opentelekomcloud-infra/github-actions/.github/actions/tox-run-env@v1
10+
with:
11+
tox-env: pdf-docs
12+
13+
- name: Upload documentation preview
14+
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
15+
uses: opentelekomcloud-infra/github-actions/.github/actions/tox-upload-swift@v1
16+
with:
17+
docs_path: "doc/build/pdf"
18+
docs_service: regions-and-endpoints
19+
swift_container: "gh_action_logs"
20+
otc_swift_username: ${{ secrets.OTC_SWIFT_USERNAME }}
21+
otc_swift_password: ${{ secrets.OTC_SWIFT_PASSWORD }}
22+
otc_swift_project_name: ${{ secrets.OTC_SWIFT_PROJECT_NAME }}
23+
otc_swift_domain: ${{ secrets.OTC_SWIFT_DOMAIN }}
24+
otc_swift_endpoint: ${{ secrets.OTC_SWIFT_ENDPOINT }}
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
repo: ${{ github.repository }}
27+
pr_number: ${{ github.event.pull_request.number }}
28+
run_id: ${{ github.run_id }}
29+
ci_platform: github

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ commands =
5656
rm -rf {toxinidir}/packages.txt
5757
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
5858
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
59-
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
59+
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then sudo apt update && xargs sudo apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
6060
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
6161

6262
[doc8]

zuul.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
merge-mode: squash-merge
44
default-branch: main
55
templates:
6-
- helpcenter-base-jobs
6+
- helpcenter-base-jobs-no-check
77
vars:
88
sphinx_pdf_files:
99
check:

0 commit comments

Comments
 (0)