Update tox.ini && conf.py file (#40)

Update tox.ini && conf.py file

Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py

Reviewed-by: Tino Schr

Author: SebastianGode

.github/workflows/build-html-docs.yaml

@@ -0,0 +1,29 @@
+name: Build HTML Docs
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+jobs:
+  tox-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: opentelekomcloud-infra/github-actions/.github/actions/tox-run-env@v1
+        with:
+          tox-env: docs
+          
+      - name: Upload documentation preview
+        if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
+        uses: opentelekomcloud-infra/github-actions/.github/actions/tox-upload-swift@v1
+        with:
+          docs_path: "doc/build/html"
+          docs_service: regions-and-endpoints
+          swift_container: "gh_action_logs"
+          otc_swift_username: ${{ secrets.OTC_SWIFT_USERNAME }}
+          otc_swift_password: ${{ secrets.OTC_SWIFT_PASSWORD }}
+          otc_swift_project_name: ${{ secrets.OTC_SWIFT_PROJECT_NAME }}
+          otc_swift_domain: ${{ secrets.OTC_SWIFT_DOMAIN }}
+          otc_swift_endpoint: ${{ secrets.OTC_SWIFT_ENDPOINT }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          repo: ${{ github.repository }}
+          pr_number: ${{ github.event.pull_request.number }}
+          run_id: ${{ github.run_id }}
+          ci_platform: github

tox.ini

@@ -56,7 +56,7 @@ commands =
     rm -rf {toxinidir}/packages.txt
     wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
     bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
-    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'
+    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'
     bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
 
 [doc8]

zuul.yaml

@@ -3,7 +3,7 @@
     merge-mode: squash-merge
     default-branch: main
     templates:
-      - helpcenter-base-jobs
+      - helpcenter-base-jobs-no-check
     vars:
       sphinx_pdf_files:
     check: