From 457b10ad13e40441ae916290d414e38602497483 Mon Sep 17 00:00:00 2001 From: Sergiy Markin Date: Sat, 5 Oct 2024 14:50:50 +0000 Subject: [PATCH] Treasuremap references update Also fixed readthedocs publishing and pumped up docker Pypi module version and updated docs generation code caused by deprecated properties in recent version of Sphinx. Change-Id: Idc69d0e6a06ba6d931acacbd22df076d01901ed0 --- .readthedocs.yaml | 10 +++++++--- .zuul.yaml | 19 +++++++++---------- doc/requirements.txt | 10 +++++----- doc/source/conf.py | 2 -- doc/source/images/architecture-pegleg.png | Bin 45469 -> 45469 bytes tools/gate/playbooks/docker-image-build.yaml | 2 +- tox.ini | 1 - 7 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f89da498..05b89471 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,7 +5,7 @@ # Required version: 2 -# Build documentation in the docs/ directory with Sphinx +# Build documentation in the doc/ directory with Sphinx sphinx: configuration: doc/source/conf.py @@ -17,9 +17,13 @@ sphinx: formats: - pdf +build: + os: "ubuntu-22.04" + tools: + python: "3.10" + # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 install: - requirements: doc/requirements.txt - - requirements: requirements.txt + - requirements: requirements-frozen.txt diff --git a/.zuul.yaml b/.zuul.yaml index 4b86c2ab..1d1871d7 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -12,9 +12,8 @@ - project: templates: - # commented out because openstack-tox-docs fails on jammy zuul nodes - - docs-on-readthedocs - release-notes-jobs-python3 + - docs-on-readthedocs vars: rtd_webhook_id: '38574' rtd_project_name: 'airship-pegleg' @@ -35,7 +34,7 @@ - openstack-tox-py310 - openstack-tox-pep8-jammy - openstack-tox-cover-jammy - - openstack-tox-docs-jammy + # - openstack-tox-docs-jammy - pegleg-dependency-vulnerability-check - airship-pegleg-validate-airskiff-manifests-jammy - airship-pegleg-docker-build-gate-ubuntu_jammy @@ -46,7 +45,7 @@ - openstack-tox-py310 - openstack-tox-pep8-jammy - openstack-tox-cover-jammy - - openstack-tox-docs-jammy + # - openstack-tox-docs-jammy - pegleg-dependency-vulnerability-check - airship-pegleg-validate-airskiff-manifests-jammy - airship-pegleg-docker-build-gate-ubuntu_jammy @@ -55,6 +54,7 @@ jobs: - airship-pegleg-docker-publish-ubuntu_jammy - pegleg-upload-git-mirror + - trigger-readthedocs-webhook - nodeset: name: airship-pegleg-single--bionic @@ -73,10 +73,10 @@ parent: openstack-tox-pep8 nodeset: openstack-single-node-jammy -- job: - name: openstack-tox-docs-jammy - parent: openstack-tox-docs - nodeset: openstack-single-node-jammy +# - job: +# name: openstack-tox-docs-jammy +# parent: openstack-tox-docs +# nodeset: openstack-single-node-jammy - job: name: openstack-tox-cover-jammy @@ -172,7 +172,7 @@ post-run: - tools/gate/playbooks/osh-infra-collect-logs.yaml vars: - treasuremap_ref: refs/changes/43/927643/6 + treasuremap_ref: v1.9 extra_volume: size: 80G type: Linux @@ -220,7 +220,6 @@ HTK_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b OSH_INFRA_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b OSH_COMMIT: 540df5cb0dbdaed63c202e2d6f2b7891062f8203 - TREASUREMAP_COMMIT: refs/changes/43/927643/6 DISTRO: ubuntu_jammy DOCKER_REGISTRY: localhost:5000 MAKE_PEGLEG_IMAGES: true diff --git a/doc/requirements.txt b/doc/requirements.txt index 28291d17..9cdb9c91 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,10 +3,10 @@ # process, which may cause wedges in the gate later. # Documentation -sphinx>=3.3.1 -oslosphinx # Apache-2.0 -sphinx_rtd_theme>=0.5.0 -docutils>=0.17 +sphinx +oslosphinx +sphinx_rtd_theme +docutils @@ -14,4 +14,4 @@ docutils>=0.17 plantuml # Releasenotes -reno>=4.0.0 # Apache-2.0 +reno diff --git a/doc/source/conf.py b/doc/source/conf.py index c756f65e..3073e44f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,6 @@ import os import sys sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('../../')) -import sphinx_rtd_theme # -- General configuration ------------------------------------------------ @@ -89,7 +88,6 @@ todo_include_todos = False # a list of builtin themes. # html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png index 8a27e8c0778420bfca110d60b5b941b4ba1e5370..dda4108646e82c320d8bcd104de8d02a1ef52100 100644 GIT binary patch delta 525 zcmV+o0`mQx;{u)I0+4Wj!EV|>5WUY=jJPy87`16sMH~v`gMrSZ%&6b?(w~So2;AB=KDOpJ9>}DN1 zR|+qTYOYVNg<}l*f0+v)JFx++%C=5w497hTd7qnO;X9#WvXv)J8zc;5@x29ubDO>O z$y=ZNzfaC1=)ksAM&pO>&HJ0%?p@4|K3*;LPMc?4kDq#fMyZ0Y;p%=q#nMzZVHroI zvnsBfkgs7v2g2`__P8GUXPtzPr+_4KP}XRl6il9G7r>|6V5sC(*-9GtG=q>gROLSP z#H31RJzOq62X` PKX4@UgQ}{tYyvT_K)40i delta 525 zcmV+o0`mQx;{u)I0+4WjO>f#j5WUZ@7;$NGFlwXpLmUtS(=-HBQbT$`s2c3Stgv^{ zdQF6?{`brp+o)gvAeZ&-?0e5MZ$~pI99dW98N9)HM%pcBQ{1YI(HTrxvn40{9V6Lz zryR$ww2ZOI4@R?gm?%muJaWyj9S(B}?+wJ3OtW%|V4Zm9WoYRcc8hk$BXnJ4c>%iZ%uLstVqj-;_ zCjX)q8Is+om~<@>actRPBo#3Zg%Pk$)*kr4r^1<9Hz7wGDttz!aH(ZqVkIaW3~-gy zb^S;-6~P?2A zO5qQq&ex4=;TVJdZ{`BXPHaG{(w&nU!*LHoK4j*U`%XAB*~$|qXCw?{@x29uw#{Dq zCUYloKjh||NMyZ^y;p%Qa#ln;}W*J9? zvuaa1Az#CUj)dPz?QuQy&pHVont&v7RMu#p6il9G7r=+xV5sC(*-9GtG=q@0RAxT) z*d$7)JzOq62cKX{IxQ&`ZPqX{qH9lb7r_f#W47%wX3+Hj0Du5VL_t(|UhLg@d`#E> PKX4@UgQ}{tYyvT_?Slbz diff --git a/tools/gate/playbooks/docker-image-build.yaml b/tools/gate/playbooks/docker-image-build.yaml index fe15e99f..b5d1dd81 100644 --- a/tools/gate/playbooks/docker-image-build.yaml +++ b/tools/gate/playbooks/docker-image-build.yaml @@ -72,7 +72,6 @@ block: - pip: name: docker - version: 4.4.4 executable: pip3 become: True @@ -115,6 +114,7 @@ username: "{{ airship_pegleg_quay_creds.username }}" password: "{{ airship_pegleg_quay_creds.password }}" registry_url: "{{ docker_registry_login_url }}" + api_version: "1.43" - make: chdir: "{{ zuul.project.src_dir }}" diff --git a/tox.ini b/tox.ini index 2f0c6ac2..c928065b 100644 --- a/tox.ini +++ b/tox.ini @@ -65,7 +65,6 @@ allowlist_externals = basepython = python3 deps= -r{toxinidir}/requirements-frozen.txt - -r{toxinidir}/test-requirements.txt -r{toxinidir}/doc/requirements.txt commands = bash -c "{toxinidir}/tools/gate/build-docs.sh"