Update docs jobs

Use tox-docs instead of obsolete build-openstack-sphinx-docs job.

Add readme to index to fix RST building.

Update tox.ini for this change,
disable sphinx's option to tread warnings as errors since nova
autogenerated code contains links to nova documents that do not work
when build here. Note that the previous build-sphinx also disabled
warnings, so this is no change in behaviour in jobs.

Update old pike link to current stein.

Update requirements for global-requirements change.

Remove unneeded json test from doc environment, there are no json files in the
doc directory and thus the test fails.

Change-Id: Id57f462ff4f1fa843051721aa78bb332b8a37fcd

.zuul.yaml

@@ -1,10 +1,8 @@
 - job:
-    name: build-compute-hyperv-sphinx-docs
+    name: compute-hyperv-openstack-tox-docs
-    parent: build-openstack-sphinx-docs
+    parent: openstack-tox-docs
     description: |
-      Run tox sphinx docs job with the nova dependency.
+      Run tox docs job with the nova dependency.
-    vars:
-      tox_install_siblings: true
     required-projects:
       - openstack/nova
 
@@ -14,8 +12,8 @@
     check:
       jobs:
         - build-openstack-releasenotes
-        - build-compute-hyperv-sphinx-docs
+        - compute-hyperv-openstack-tox-docs
     gate:
       jobs:
         - build-openstack-releasenotes
-        - build-compute-hyperv-sphinx-docs
+        - compute-hyperv-openstack-tox-docs

doc/source/index.rst

@@ -1,8 +1,3 @@
-.. compute-hyperv documentation master file, created by
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 ==============================================
 Welcome to the documentation of compute_hyperv
 ==============================================
@@ -28,6 +23,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   readme
    contributing
    install/index
    troubleshooting/index

doc/source/usage/index.rst

@@ -177,7 +177,7 @@ The boot order can be specified when creating a new instance:
 For more details on block devices, including more details about setting the
 the boot order, you can check the `block device mapping docs`__.
 
-__ https://docs.openstack.org/nova/pike/user/block-device-mapping.html#block-device-mapping-v2
+__ https://docs.openstack.org/nova/stein/user/block-device-mapping.html#block-device-mapping-v2
 
 
 RemoteFX

setup.cfg

@@ -32,14 +32,6 @@ packages =
 oslo.config.opts =
     compute_hyperv = compute_hyperv.nova.conf:list_opts
 
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
 [compile_catalog]
 directory = compute_hyperv/locale
 domain = compute-hyperv

test-requirements.txt

@@ -7,7 +7,8 @@ hacking<0.13,>=0.12.0 # Apache-2.0
 coverage!=4.4,>=4.0 # Apache-2.0
 ddt>=1.0.1 # MIT
 python-subunit>=1.0.0 # Apache-2.0/BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+sphinx>=1.6.2,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7'  # BSD
+sphinx>=1.6.2,!=1.6.6,!=1.6.7;python_version>='3.4'  # BSD
 oslo.config>=5.2.0 # Apache-2.0
 oslotest>=3.2.0 # Apache-2.0
 stestr>=2.0.0 # Apache-2.0

tox.ini

@@ -49,9 +49,13 @@ commands = {posargs}
 
 [testenv:docs]
 basepython = python3
+deps = -r{toxinidir}/requirements.txt
+       -r{toxinidir}/test-requirements.txt
+       -egit+https://github.com/openstack/nova#egg=nova
 commands =
-  python setup.py build_sphinx
+  # We cannot use -W here since nova docs contain links to the nova tree
-  bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'
+  # that leads to invalid links for this build.
+  sphinx-build -a -E -d doc/build/doctrees -b html doc/source doc/build/html
 
 [testenv:releasenotes]
 basepython = python3