From 9a324f5efa5fd8203fabc0e9441666bcfa985028 Mon Sep 17 00:00:00 2001 From: Sebastian Gode Date: Thu, 16 Oct 2025 12:10:18 +0000 Subject: [PATCH] Update tox.ini && conf.py file Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py --- .github/workflows/build-html-docs.yaml | 29 ++++++++++++++++++++++++++ .github/workflows/build-pdf-docs.yaml | 29 ++++++++++++++++++++++++++ doc/requirements.txt | 4 +--- doc/source/conf.py | 4 +--- tox.ini | 2 +- zuul.yaml | 2 +- 6 files changed, 62 insertions(+), 8 deletions(-) create mode 100644 .github/workflows/build-html-docs.yaml create mode 100644 .github/workflows/build-pdf-docs.yaml diff --git a/.github/workflows/build-html-docs.yaml b/.github/workflows/build-html-docs.yaml new file mode 100644 index 0000000..21e44b6 --- /dev/null +++ b/.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: docs-on-docs + 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 \ No newline at end of file diff --git a/.github/workflows/build-pdf-docs.yaml b/.github/workflows/build-pdf-docs.yaml new file mode 100644 index 0000000..e510efb --- /dev/null +++ b/.github/workflows/build-pdf-docs.yaml @@ -0,0 +1,29 @@ +name: Build PDF Docs +on: + pull_request: + types: [opened, reopened, synchronize, edited] +jobs: + tox-pdf-docs: + runs-on: ubuntu-latest + steps: + - uses: opentelekomcloud-infra/github-actions/.github/actions/tox-run-env@v1 + with: + tox-env: pdf-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/pdf" + docs_service: docs-on-docs + 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 \ No newline at end of file diff --git a/doc/requirements.txt b/doc/requirements.txt index 4705eca..7758d4b 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,4 @@ sphinx>=2.0.0,!=2.1.0 # BSD -myst_parser -sphinx-revealjs otcdocstheme<2.0.0 # Apache-2.0 @@ -11,4 +9,4 @@ otc-sphinx-directives>=0.1.0 sphinx-minify>=0.0.1 # Apache-2.0 git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-rework.git#egg=otc_metadata setuptools -gitpython +gitpython \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index c5f285c..e92051c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,8 +20,6 @@ from datetime import datetime extensions = [ - 'sphinx_revealjs', - 'myst_parser', 'otcdocstheme', 'otc_sphinx_directives' ] @@ -133,4 +131,4 @@ \newcommand{{\servicetitle}}{{{otcdocs_service_title}}} ''', 'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm' -} +} \ No newline at end of file diff --git a/tox.ini b/tox.ini index a89412f..5b276fb 100644 --- a/tox.ini +++ b/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] diff --git a/zuul.yaml b/zuul.yaml index 4306b22..bc6c8e3 100644 --- a/zuul.yaml +++ b/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: