From 90c427d630d2025074448b543b63699c9da13d87 Mon Sep 17 00:00:00 2001
From: "James E. Blair" <jim@acmegating.com>
Date: Wed, 15 Dec 2021 14:57:51 -0800
Subject: [PATCH] Switch docs theme to RTD

To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul.

This does not use the versioning feature due to the nature of this repo.

This also corrects a reference which is now an error.

Change-Id: Ia1d31df932b447f11bc588925de9974d4f6dfc7d
---
 doc/requirements.txt                |   1 +
 doc/source/_static/logo.svg         | 100 +++++++++++++++++++++++-----
 doc/source/conf.py                  |  48 ++++++++-----
 roles/upload-artifactory/README.rst |   2 +-
 test-playbooks/artifactory/run.yaml |   2 +-
 5 files changed, 116 insertions(+), 37 deletions(-)

diff --git a/doc/requirements.txt b/doc/requirements.txt
index b93bdc68b..6808065ca 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,3 +2,4 @@ zuul-sphinx>=0.1.1
 sphinxcontrib-blockdiag>=1.1.0
 funcparserlib>=1.0.0a0  # https://github.com/blockdiag/blockdiag/pull/148
 sphinxcontrib-seqdiag
+sphinx_rtd_theme
diff --git a/doc/source/_static/logo.svg b/doc/source/_static/logo.svg
index ded6d3414..0cc6b72a2 100644
--- a/doc/source/_static/logo.svg
+++ b/doc/source/_static/logo.svg
@@ -1,22 +1,86 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 22.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 144 144" style="enable-background:new 0 0 144 144;" xml:space="preserve">
-<style type="text/css">
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   version="1.1"
+   id="Layer_1"
+   x="0px"
+   y="0px"
+   viewBox="0 0 1999.9989 533.33301"
+   xml:space="preserve"
+   sodipodi:docname="Zuul_Logo_Full_Horizontal_RGB_DarkBlue.svg"
+   width="1999.9988"
+   height="533.33301"
+   inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
+   id="metadata1646"><rdf:RDF><cc:Work
+       rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
+         rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
+   id="defs1644" /><sodipodi:namedview
+   pagecolor="#ffffff"
+   bordercolor="#666666"
+   borderopacity="1"
+   objecttolerance="10"
+   gridtolerance="10"
+   guidetolerance="10"
+   inkscape:pageopacity="0"
+   inkscape:pageshadow="2"
+   inkscape:window-width="1983"
+   inkscape:window-height="845"
+   id="namedview1642"
+   showgrid="false"
+   fit-margin-top="0"
+   fit-margin-left="0"
+   fit-margin-right="0"
+   fit-margin-bottom="0"
+   inkscape:zoom="0.2545462"
+   inkscape:cx="107.94999"
+   inkscape:cy="28.799999"
+   inkscape:window-x="235"
+   inkscape:window-y="67"
+   inkscape:window-maximized="0"
+   inkscape:current-layer="Layer_1" />
+<style
+   type="text/css"
+   id="style1625">
 	.st0{fill:#071D49;}
 </style>
-<g>
-	<path class="st0" d="M12.8,102.6h118.5L106,58.8v-15l7-9.2H92L72,0L52,34.7H31.1l7,9.2v15L12.8,102.6z M38,96.6H23.1L38,70.8V96.6z
-		 M48.4,96.6H44V61.3h4.3V96.6z M48.4,55.3H44V51h4.3V55.3z M69,96.6H54.3V61.3H69V96.6z M89.7,96.6H75V61.3h14.7V96.6z M89.7,55.3
-		H54.3V51h35.3V55.3z M100,96.6h-4.3V61.3h4.3V96.6z M100,55.3h-4.3V51h4.3V55.3z M106,70.8l14.9,25.8H106V70.8z M72,12l13.1,22.7
-		H58.9L72,12z M100.9,40.7l-0.9,1.2V45H44v-3.2l-0.9-1.2H100.9z"/>
-	<polygon class="st0" points="138.2,137.3 125.1,137.3 125.1,114.6 119.1,118.1 119.1,137.3 119.1,139.6 119.1,143.3 141.6,143.3 	
-		"/>
-	<path class="st0" d="M99.1,131.5L99.1,131.5L99.1,131.5c0,3.6-2.9,6.5-6.5,6.5c-3.6,0-6.5-2.9-6.5-6.5v0h0v-16.9l-6,3.5v13.5v0
-		c0,6.9,5.6,12.5,12.5,12.5c6.9,0,12.5-5.6,12.5-12.5v0v-16.9l-6,3.5V131.5z"/>
-	<path class="st0" d="M60.2,131.5L60.2,131.5L60.2,131.5c0,3.6-2.9,6.5-6.5,6.5c-3.6,0-6.5-2.9-6.5-6.5v0h0v-16.9l-6,3.5v13.5v0
-		c0,6.9,5.6,12.5,12.5,12.5c6.9,0,12.5-5.6,12.5-12.5v0v-16.9l-6,3.5V131.5z"/>
-	<polygon class="st0" points="25.8,114.6 25.4,114.6 18.9,114.6 5.8,114.6 2.4,120.6 15.5,120.6 2.4,143.3 23.8,143.3 27.3,137.3 
-		12.7,137.3 	"/>
+<g
+   id="g1639"
+   transform="matrix(9.2592535,0,0,9.2592535,-316.66647,-399.99975)"
+   style="fill:#ffffff;fill-opacity:1">
+	<path
+   class="st0"
+   d="m 34.2,100.8 h 66.5 L 86.5,76.2 v -8.4 l 3.9,-5.1 H 78.6 L 67.4,43.2 56.2,62.7 H 44.4 l 3.9,5.1 v 8.4 z M 48.4,97.4 H 40 l 8.4,-14.5 z m 5.7,0 H 51.7 V 77.6 h 2.4 z m 0,-23.1 h -2.4 v -2.4 h 2.4 z M 65.7,97.4 H 57.5 V 77.6 h 8.2 z m 11.6,0 H 69.1 V 77.6 h 8.2 z m 0,-23.1 H 57.5 v -2.4 h 19.8 z m 5.8,23.1 H 80.7 V 77.6 h 2.4 z m 0,-23.1 h -2.4 v -2.4 h 2.4 z m 3.4,8.6 8.4,14.5 h -8.4 z m -19.1,-33 7.4,12.7 H 60 Z M 83.6,66 83.1,66.7 v 1.8 H 51.7 V 66.7 L 51.2,66 Z"
+   id="path1627"
+   style="fill:#ffffff;fill-opacity:1" />
+	<g
+   id="g1637"
+   style="fill:#ffffff;fill-opacity:1">
+		<polygon
+   class="st0"
+   points="227.5,86 250.2,86 246.7,80 233.5,80 233.5,57.2 227.5,60.7 "
+   id="polygon1629"
+   style="fill:#ffffff;fill-opacity:1" />
+		<path
+   class="st0"
+   d="m 207.5,74.2 v 0 0 c 0,3.6 -2.9,6.5 -6.5,6.5 -3.6,0 -6.5,-2.9 -6.5,-6.5 v 0 0 -17 l -6,3.5 v 13.5 0 c 0,6.9 5.6,12.5 12.5,12.5 6.9,0 12.5,-5.6 12.5,-12.5 v 0 -17 l -6,3.5 z"
+   id="path1631"
+   style="fill:#ffffff;fill-opacity:1" />
+		<path
+   class="st0"
+   d="m 168.4,74.2 v 0 0 c 0,3.6 -2.9,6.5 -6.5,6.5 -3.6,0 -6.5,-2.9 -6.5,-6.5 v 0 0 -17 l -6,3.5 v 13.5 0 c 0,6.9 5.6,12.5 12.5,12.5 6.9,0 12.5,-5.6 12.5,-12.5 v 0 -17 l -6,3.5 z"
+   id="path1633"
+   style="fill:#ffffff;fill-opacity:1" />
+		<polygon
+   class="st0"
+   points="110.4,86 131.9,86 135.4,80 120.8,80 133.9,57.2 113.8,57.2 110.4,63.3 123.5,63.3 "
+   id="polygon1635"
+   style="fill:#ffffff;fill-opacity:1" />
+	</g>
 </g>
 </svg>
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 1cdba5f9b..bafe9287c 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,22 +12,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import sys, os, datetime
+
+sys.path.insert(0, os.path.abspath('../..'))
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    # 'sphinx.ext.intersphinx',
     'sphinxcontrib.blockdiag',
     'sphinxcontrib.seqdiag',
     'zuul_sphinx',
+    'sphinx_rtd_theme',
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
 
+primary_domain = 'zuul'
+
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -35,8 +39,8 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'zuul-jobs'
-copyright = u'2017, Zuul contributors'
+project = u'Zuul-Jobs'
+copyright = u'2012-%s, Zuul project contributors' % datetime.date.today().year
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
@@ -52,9 +56,25 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme_path = ["."]
-# html_theme = '_theme'
-# html_static_path = ['static']
+html_theme = "sphinx_rtd_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
+# documentation.
+html_theme_options = {
+    'collapse_navigation': False,
+    'navigation_depth': -1,
+    'logo_only': True,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = '_static/logo.svg'
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
@@ -66,22 +86,16 @@ latex_documents = [
     ('index',
      '%s.tex' % project,
      u'%s Documentation' % project,
-     u'OpenStack Foundation', 'manual'),
+     u'Zuul contributors', 'manual'),
 ]
 
 # Example configuration for intersphinx: refer to the Python standard library.
-# intersphinx_mapping = {'http://docs.python.org/': None}
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-html_logo = '_static/logo.svg'
+#intersphinx_mapping = {'http://docs.python.org/': None}
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #html_favicon = None
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# Additional Zuul role paths
+zuul_role_paths = []
diff --git a/roles/upload-artifactory/README.rst b/roles/upload-artifactory/README.rst
index ddc7daf19..89acd170e 100644
--- a/roles/upload-artifactory/README.rst
+++ b/roles/upload-artifactory/README.rst
@@ -79,7 +79,7 @@ Upload artifacts specified from the executor to artifactory.
        .. zuul:rolevar:: instance
 
           Artifactory instance to place the artiface in, this is to
-          choose which entry in :attr:`upload_artifactory_instances` to upload
+          choose which entry in :zuul:rolevar:`upload-artifactory.upload_artifactory_instances` to upload
           the artifact to.
 
        .. zuul:rolevar:: headers
diff --git a/test-playbooks/artifactory/run.yaml b/test-playbooks/artifactory/run.yaml
index 7190971ea..050f55afa 100644
--- a/test-playbooks/artifactory/run.yaml
+++ b/test-playbooks/artifactory/run.yaml
@@ -106,7 +106,7 @@
   post_tasks:
     - name: Load artifacts information from zuul_return
       set_fact:
-        artifacts: "{{ (lookup('file', zuul.executor.work_root + '/results.json') | from_json) ['zuul']['artifacts'] }}"
+        artifacts: "{{ (lookup('file', zuul.executor.work_root + '/results.json') | from_json) ['data']['zuul']['artifacts'] }}"
     - name: Expected artifacts are backwards
       set_fact:
         expected_artifacts: