nova-specs docs builds fail with sphinx 1.6.2: Citation is not referenced.

[Takashi Natsume]

This issue seemed be fixed in https://bugs.launchpad.net/nova/+bug/1693010.
But it has not been fixed yet.

http://logs.openstack.org/47/460847/5/check/gate-nova-specs-docs-ubuntu-xenial/e4e669b/console.html

2017-06-01 23:31:09.904757 | Running Sphinx v1.6.2
(snipped...)
2017-06-01 23:31:44.280392 | scanning /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source for redirects...
2017-06-01 23:31:44.281018 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/juno/redirects
2017-06-01 23:31:44.287320 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/liberty/redirects
2017-06-01 23:31:44.290284 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/queens/redirects
2017-06-01 23:31:44.290664 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/kilo/redirects
2017-06-01 23:31:44.293625 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/ocata/redirects
2017-06-01 23:31:44.295852 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/pike/redirects
2017-06-01 23:31:44.296663 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/mitaka/redirects
2017-06-01 23:31:44.300105 | found redirects at /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/newton/redirects
2017-06-01 23:31:44.304215 | ...done
2017-06-01 23:31:45.098021 | pickling environment... done
2017-06-01 23:31:45.099044 | checking consistency...
2017-06-01 23:31:45.099110 | Warning, treated as error:
2017-06-01 23:31:45.099207 | /home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/doc/source/specs/juno/implemented/pci-passthrough-sriov.rst:412:Citation [VIF_DETA] is not referenced.
2017-06-01 23:31:45.323528 | ERROR: InvocationError: '/home/jenkins/workspace/gate-nova-specs-docs-ubuntu-xenial/.tox/venv/bin/python setup.py build_sphinx'
2017-06-01 23:31:45.323612 | ___________________________________ summary ____________________________________
2017-06-01 23:31:45.323637 | ERROR: venv: commands failed
2017-06-01 23:31:45.334621 | [Zuul] Task exit code: 1
2017-06-01 23:31:46.425403 | [Zuul] Job complete, result: FAILURE

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/470077

[OpenStack Infra (hudson-openstack)]

Change abandoned by Takashi NATSUME (<email address hidden>) on branch: master
Review: https://review.openstack.org/470077

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/470252
Committed: https://git.openstack.org/cgit/openstack/nova-specs/commit/?id=77b2ae9c5f5efdf1d565794921077458aedd8be9
Submitter: Jenkins
Branch: master

commit 77b2ae9c5f5efdf1d565794921077458aedd8be9
Author: Dirk Mueller <email address hidden>
Date: Fri Jun 2 13:14:04 2017 +0200

    Fix citation references (Sphinx 1.6.x compatibility)

    Sphinx 1.6.x gained a cross-reference check warning that caused
    the build to fail in "tox -e docs" environment. Removing underscores
    from the citation reference identifier ensures that the cross references
    are properly detected. Similarly missing references to footnotes are
    now a warning (which is upgraded to an error in the docs tox
    environment) so adjust references where it makes sense and is needed.

    Closes-Bug: #1695127
    Change-Id: I7e55dcf910e0ba6dd85b565db8cb1ecbdd39634a

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/471153

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/471153
Committed: https://git.openstack.org/cgit/openstack/nova-specs/commit/?id=f49397be06404d310483f49b2c062c8b3dd70767
Submitter: Jenkins
Branch: master

commit f49397be06404d310483f49b2c062c8b3dd70767
Author: Takashi NATSUME <email address hidden>
Date: Tue Jun 6 07:33:25 2017 +0900

    Uncap sphinx version

    Sphinx version has been capped since
    I9c45d239e156ec4fb49b5d8bd2404b66155be92b
    in order to fix an issue with resolving citations.

    Then, in I7e55dcf910e0ba6dd85b565db8cb1ecbdd39634a,
    the issue has been fixed by modifying citation references.

    So uncap sphinx version.
    But sphinx 1.6.1 has another issue (*1),
    so leave sphinx 1.6.1 in the blacklist.

    *1: https://github.com/sphinx-doc/sphinx/issues/3754

    Change-Id: I09acc562bc37edc3c8a40027f7eb359aaa956c32
    Related-Bug: #1695127