Switch remaining docs publications jobs to sphinx

This gets the main publish-openstack-sphinx jobs, plus api-ref,
api-guide, deploy-guide, install-guide and placement-api-ref.

The write_root_marker and prepare-docs-for-afs roles have been udpated
to have good defaults and also to honor sphinx_build_dir as a variable,
so remove setting those explicitly.

Depends-On: I7c3d578a00a4aa4c9e175f5f83e3171c6f6a4a61
Change-Id: I9ed0b02d6ca20a6b679507c4d988531abc55b09d

playbooks/publish/api-guide.yaml

@@ -1,11 +1,8 @@
 - hosts: all
   roles:
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/api-guide/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/api-guide/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/api-ref.yaml

@@ -1,11 +1,8 @@
 - hosts: all
   roles:
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/api-ref/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/api-ref/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/contributor-guide-afs.yaml

@@ -1,11 +1,8 @@
 - hosts: all
   roles:
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/doc/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/doc/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/deploy-guide.yaml

@@ -1,14 +1,10 @@
 - hosts: all
   roles:
     - role: prepare-docs-for-afs
-      doc_toplevel_dir: "deploy-guide"
       when: zuul_success | bool
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/deploy-guide/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/deploy-guide/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/install-guide.yaml

@@ -1,14 +1,10 @@
 - hosts: all
   roles:
     - role: prepare-docs-for-afs
-      doc_toplevel_dir: "install-guide"
       when: zuul_success | bool
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/install-guide/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/install-guide/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/openstack-specs.yaml

@@ -1,8 +1,6 @@
 - hosts: all
   roles:
-    - fetch-tox-output
     - role: fetch-sphinx-output
-      sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/placement-api-ref.yaml

@@ -1,11 +1,8 @@
 - hosts: all
   roles:
-    - fetch-tox-output
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/placement-api-ref/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/placement-api-ref/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/publish/releasenotes.yaml

@@ -1,10 +1,8 @@
 - hosts: all
   roles:
     - role: write-root-marker
-      root_marker_dir: "{{ zuul.project.src_dir }}/releasenotes/build/html/"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "{{ zuul.project.src_dir }}/releasenotes/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool
 

playbooks/sphinx/neutron-horizon-hack.yaml

@@ -0,0 +1,4 @@
+# TODO(mordred) ZOMG DELETE THIS
+- hosts: all
+  roles:
+    - neutron-horizon-hack

playbooks/sphinx/post-direct.yaml

@@ -1,9 +1,7 @@
 - hosts: all
   roles:
     - role: write-root-marker
-      root_marker_dir: "src/{{ zuul.project.canonical_name }}/doc/build/html"
       when: zuul_success | bool
     - role: fetch-sphinx-output
-      sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"
       when: zuul_success | bool

playbooks/sphinx/post-infra.yaml

@@ -2,5 +2,4 @@
   roles:
     - prepare-infra-docs-for-afs
     - role: fetch-sphinx-output
-      sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"

playbooks/sphinx/post.yaml

@@ -2,5 +2,4 @@
   roles:
     - prepare-docs-for-afs
     - role: fetch-sphinx-output
-      sphinx_output_src: "src/{{ zuul.project.canonical_name }}/doc/build/html/"
       zuul_executor_dest: "{{ zuul.executor.work_root }}/artifacts"

zuul.d/jobs.yaml

@@ -196,21 +196,24 @@
       Publishes depending on branch to latest/ (for master), or the
       basename of the branch like pike (for stable/pike).
     final: true
-    pre-run: playbooks/project-config/pre-tox.yaml
+    pre-run:
-    run: playbooks/project-config/run-tox.yaml
+      - playbooks/sphinx/pre.yaml
+      # TODO(mordred) REMOVE THIS HACK
+      - playbooks/sphinx/neutron-horizon-hack.yaml
+    run: playbooks/sphinx/run.yaml
     post-run:
-      - playbooks/project-config/post-tox.yaml
       - playbooks/sphinx/post.yaml
       - playbooks/publish/openstack-afs.yaml
     required-projects:
       - name: openstack/requirements
+      # TODO(mordred) REMOVE THIS HACK ONCE neutron-horizon-hack is removed
+      - name: openstack/neutron
+      - name: openstack/horizon
     roles:
       - zuul: openstack-infra/zuul-jobs
       - zuul: openstack-infra/openstack-zuul-jobs
     vars:
-      tox_constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
+      constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
-      tox_envlist: venv
-      tox_extra_args: -vv python setup.py build_sphinx
     secrets:
       - secret: afsdocs_secret
         name: afs
@@ -362,6 +365,7 @@
       - zuul: openstack-infra/zuul-jobs
     vars:
       constraints_file: '{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt'
+      sphinx_build_dir: releasenotes/build
     secrets:
       - secret: afsdocs_secret
         name: afs
@@ -505,7 +509,6 @@
     description: |
       Publish the publication index
     final: true
-    pre-run: playbooks/project-config/pre-tox.yaml
     run: playbooks/publications-index/run.yaml
     post-run: playbooks/publish/publications-index.yaml
     allowed-projects:
@@ -524,7 +527,6 @@
     description: |
       Publish one publication from openstack-infra/publications
     final: true
-    pre-run: playbooks/project-config/pre-tox.yaml
     run: playbooks/publications/run.yaml
     post-run: playbooks/publish/publications.yaml
     allowed-projects:
@@ -728,8 +730,8 @@
     description: |
       Publish api-guide document to
       https://developer.openstack.org/api-guide.
-    pre-run: playbooks/project-config/pre-tox.yaml
+    pre-run: playbooks/sphinx/pre.yaml
-    run: playbooks/project-config/run-tox.yaml
+    run: playbooks/sphinx/run.yaml
     post-run: playbooks/publish/api-guide.yaml
     roles:
       - zuul: openstack-infra/zuul-jobs
@@ -738,7 +740,8 @@
     # for changes on other branches.
     branches: master
     vars:
-      tox_envlist: api-guide
+      sphinx_source_dir: api-guide/source
+      sphinx_build_dir: api-guide/build
     secrets:
       - secret: afsdeveloper_secret
         name: afs
@@ -748,8 +751,8 @@
     description: |
       Publish api-ref document to
       https://developer.openstack.org/api-ref.
-    pre-run: playbooks/project-config/pre-tox.yaml
+    pre-run: playbooks/sphinx/pre.yaml
-    run: playbooks/project-config/run-tox.yaml
+    run: playbooks/sphinx/run.yaml
     post-run: playbooks/publish/api-ref.yaml
     roles:
       - zuul: openstack-infra/zuul-jobs
@@ -758,7 +761,8 @@
     # for changes on other branches.
     branches: master
     vars:
-      tox_envlist: api-ref
+      sphinx_build_dir: api-ref/build
+      sphinx_source_dir: api-ref/source
     secrets:
       - secret: afsdeveloper_secret
         name: afs
@@ -768,8 +772,10 @@
     description: |
       Publish placement-api-ref document to
       https://developer.openstack.org/api-ref/placement.
-    pre-run: playbooks/project-config/pre-tox.yaml
+    allowed-projects:
-    run: playbooks/project-config/run-tox.yaml
+      - openstack/nova
+    pre-run: playbooks/sphinx/pre.yaml
+    run: playbooks/sphinx/run.yaml
     post-run: playbooks/publish/placement-api-ref.yaml
     roles:
       - zuul: openstack-infra/zuul-jobs
@@ -778,7 +784,8 @@
     # for changes on other branches.
     branches: master
     vars:
-      tox_envlist: placement-api-ref
+      sphinx_build_dir: placement-api-ref/build
+      sphinx_source_dir: placement-api-ref/source
     secrets:
       - secret: afsdeveloper_secret
         name: afs
@@ -788,8 +795,8 @@
     description: |
       Publish install-guide document to
       https://docs.openstack.org/project-install-guide/
-    pre-run: playbooks/project-config/pre-tox.yaml
+    pre-run: playbooks/sphinx/pre.yaml
-    run: playbooks/project-config/run-tox.yaml
+    run: playbooks/sphinx/run.yaml
     post-run: playbooks/publish/install-guide.yaml
     roles:
       - zuul: openstack-infra/zuul-jobs
@@ -799,7 +806,8 @@
     branches:
       - stable/ocata
     vars:
-      tox_envlist: install-guide
+      sphinx_build_dir: install-guide/build
+      sphinx_source_dir: install-guide/source
     secrets:
       - secret: afsdocs_secret
         name: afs
@@ -809,8 +817,8 @@
     description: |
       Publish deploy-guide document to
       https://docs.openstack.org/project-deploy-guide/
-    pre-run: playbooks/project-config/pre-tox.yaml
+    pre-run: playbooks/sphinx/pre.yaml
-    run: playbooks/project-config/run-tox.yaml
+    run: playbooks/sphinx/run.yaml
     post-run: playbooks/publish/deploy-guide.yaml
     roles:
       - zuul: openstack-infra/zuul-jobs
@@ -819,7 +827,8 @@
     # for changes on other branches.
     branches: master
     vars:
-      tox_envlist: deploy-guide
+      sphinx_build_dir: deploy-guide/build
+      sphinx_source_dir: deploy-guide/source
     secrets:
       - secret: afsdocs_secret
         name: afs