From 67977f98858d5dc5972cb04a7408618bc7401066 Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Tue, 11 Jul 2017 19:37:30 +0000 Subject: [PATCH] Enable warning-is-error for doc builds Some of the documentation linking is broken, and will need to be fixed as the documentation is revamped for the doc migration. Change-Id: I23a5f8a7c0cc7b0ce19052a2383e20b96e195996 --- README.rst | 2 +- doc/source/howto.rst | 4 ++-- setup.cfg | 1 + troubleshooting.rst | 4 ++-- 4 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 6fd499374..d86721232 100644 --- a/README.rst +++ b/README.rst @@ -177,7 +177,7 @@ in a stand-alone fashion. changing the nginx configuration accordingly. * Bifrost playbooks can leverage and optionally install keystone. - See :ref:`keystone`. + See `doc/source/keystone.rst`. * Neutron is NOT installed. Ironic performs static IP injection via config-drive. diff --git a/doc/source/howto.rst b/doc/source/howto.rst index a27488df3..9b3ece21e 100644 --- a/doc/source/howto.rst +++ b/doc/source/howto.rst @@ -27,8 +27,8 @@ which should print an empty table if connection to Ironic works as expected. Enroll Hardware =============== -The following requirements are installed during the `Installation`_ step -above: +The following requirements are installed during the install process +as documented in the install documentation. - openstack-infra/shade library - openstack-infra/os-client-config diff --git a/setup.cfg b/setup.cfg index 8ce25516f..36e75bbe0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -30,6 +30,7 @@ console_scripts = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 [upload_sphinx] upload-dir = doc/build/html diff --git a/troubleshooting.rst b/troubleshooting.rst index 9880f96ce..195ea4e66 100644 --- a/troubleshooting.rst +++ b/troubleshooting.rst @@ -72,8 +72,8 @@ For documentation on diskimage-builder, See:: http://docs.openstack.org/developer/diskimage-builder/. It should be noted that the steps for diskimage-builder installation and -use to create an IPA image for Bifrost are the same as for ironic. See:: - http://docs.openstack.org/developer/ironic/deploy/install-guide.html#image-requirements +use to create an IPA image for Bifrost are the same as for ironic. See: +http://docs.openstack.org/developer/ironic/deploy/install-guide.html#image-requirements This essentially boils down to the following steps: