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
This commit is contained in:
Sergiy Markin 2024-10-05 14:50:50 +00:00
parent c8bfeb19d7
commit 457b10ad13
7 changed files with 22 additions and 22 deletions

View File

@ -5,7 +5,7 @@
# Required # Required
version: 2 version: 2
# Build documentation in the docs/ directory with Sphinx # Build documentation in the doc/ directory with Sphinx
sphinx: sphinx:
configuration: doc/source/conf.py configuration: doc/source/conf.py
@ -17,9 +17,13 @@ sphinx:
formats: formats:
- pdf - pdf
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
# Optionally set the version of Python and requirements required to build your docs # Optionally set the version of Python and requirements required to build your docs
python: python:
version: 3.7
install: install:
- requirements: doc/requirements.txt - requirements: doc/requirements.txt
- requirements: requirements.txt - requirements: requirements-frozen.txt

View File

@ -12,9 +12,8 @@
- project: - project:
templates: templates:
# commented out because openstack-tox-docs fails on jammy zuul nodes
- docs-on-readthedocs
- release-notes-jobs-python3 - release-notes-jobs-python3
- docs-on-readthedocs
vars: vars:
rtd_webhook_id: '38574' rtd_webhook_id: '38574'
rtd_project_name: 'airship-pegleg' rtd_project_name: 'airship-pegleg'
@ -35,7 +34,7 @@
- openstack-tox-py310 - openstack-tox-py310
- openstack-tox-pep8-jammy - openstack-tox-pep8-jammy
- openstack-tox-cover-jammy - openstack-tox-cover-jammy
- openstack-tox-docs-jammy # - openstack-tox-docs-jammy
- pegleg-dependency-vulnerability-check - pegleg-dependency-vulnerability-check
- airship-pegleg-validate-airskiff-manifests-jammy - airship-pegleg-validate-airskiff-manifests-jammy
- airship-pegleg-docker-build-gate-ubuntu_jammy - airship-pegleg-docker-build-gate-ubuntu_jammy
@ -46,7 +45,7 @@
- openstack-tox-py310 - openstack-tox-py310
- openstack-tox-pep8-jammy - openstack-tox-pep8-jammy
- openstack-tox-cover-jammy - openstack-tox-cover-jammy
- openstack-tox-docs-jammy # - openstack-tox-docs-jammy
- pegleg-dependency-vulnerability-check - pegleg-dependency-vulnerability-check
- airship-pegleg-validate-airskiff-manifests-jammy - airship-pegleg-validate-airskiff-manifests-jammy
- airship-pegleg-docker-build-gate-ubuntu_jammy - airship-pegleg-docker-build-gate-ubuntu_jammy
@ -55,6 +54,7 @@
jobs: jobs:
- airship-pegleg-docker-publish-ubuntu_jammy - airship-pegleg-docker-publish-ubuntu_jammy
- pegleg-upload-git-mirror - pegleg-upload-git-mirror
- trigger-readthedocs-webhook
- nodeset: - nodeset:
name: airship-pegleg-single--bionic name: airship-pegleg-single--bionic
@ -73,10 +73,10 @@
parent: openstack-tox-pep8 parent: openstack-tox-pep8
nodeset: openstack-single-node-jammy nodeset: openstack-single-node-jammy
- job: # - job:
name: openstack-tox-docs-jammy # name: openstack-tox-docs-jammy
parent: openstack-tox-docs # parent: openstack-tox-docs
nodeset: openstack-single-node-jammy # nodeset: openstack-single-node-jammy
- job: - job:
name: openstack-tox-cover-jammy name: openstack-tox-cover-jammy
@ -172,7 +172,7 @@
post-run: post-run:
- tools/gate/playbooks/osh-infra-collect-logs.yaml - tools/gate/playbooks/osh-infra-collect-logs.yaml
vars: vars:
treasuremap_ref: refs/changes/43/927643/6 treasuremap_ref: v1.9
extra_volume: extra_volume:
size: 80G size: 80G
type: Linux type: Linux
@ -220,7 +220,6 @@
HTK_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b HTK_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b
OSH_INFRA_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b OSH_INFRA_COMMIT: 43fd7143481b6ddda0dbd2f26bf6ec39a417b15b
OSH_COMMIT: 540df5cb0dbdaed63c202e2d6f2b7891062f8203 OSH_COMMIT: 540df5cb0dbdaed63c202e2d6f2b7891062f8203
TREASUREMAP_COMMIT: refs/changes/43/927643/6
DISTRO: ubuntu_jammy DISTRO: ubuntu_jammy
DOCKER_REGISTRY: localhost:5000 DOCKER_REGISTRY: localhost:5000
MAKE_PEGLEG_IMAGES: true MAKE_PEGLEG_IMAGES: true

View File

@ -3,10 +3,10 @@
# process, which may cause wedges in the gate later. # process, which may cause wedges in the gate later.
# Documentation # Documentation
sphinx>=3.3.1 sphinx
oslosphinx # Apache-2.0 oslosphinx
sphinx_rtd_theme>=0.5.0 sphinx_rtd_theme
docutils>=0.17 docutils
@ -14,4 +14,4 @@ docutils>=0.17
plantuml plantuml
# Releasenotes # Releasenotes
reno>=4.0.0 # Apache-2.0 reno

View File

@ -20,7 +20,6 @@ import os
import sys import sys
sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../../')) sys.path.insert(0, os.path.abspath('../../'))
import sphinx_rtd_theme
# -- General configuration ------------------------------------------------ # -- General configuration ------------------------------------------------
@ -89,7 +88,6 @@ todo_include_todos = False
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = "sphinx_rtd_theme" 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 # 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 # further. For a list of options available for each theme, see the

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -72,7 +72,6 @@
block: block:
- pip: - pip:
name: docker name: docker
version: 4.4.4
executable: pip3 executable: pip3
become: True become: True
@ -115,6 +114,7 @@
username: "{{ airship_pegleg_quay_creds.username }}" username: "{{ airship_pegleg_quay_creds.username }}"
password: "{{ airship_pegleg_quay_creds.password }}" password: "{{ airship_pegleg_quay_creds.password }}"
registry_url: "{{ docker_registry_login_url }}" registry_url: "{{ docker_registry_login_url }}"
api_version: "1.43"
- make: - make:
chdir: "{{ zuul.project.src_dir }}" chdir: "{{ zuul.project.src_dir }}"

View File

@ -65,7 +65,6 @@ allowlist_externals =
basepython = python3 basepython = python3
deps= deps=
-r{toxinidir}/requirements-frozen.txt -r{toxinidir}/requirements-frozen.txt
-r{toxinidir}/test-requirements.txt
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt
commands = commands =
bash -c "{toxinidir}/tools/gate/build-docs.sh" bash -c "{toxinidir}/tools/gate/build-docs.sh"