From 0970e3d0313e2d71958be97f690d65306103d016 Mon Sep 17 00:00:00 2001 From: Pavlo Shchelokovskyy Date: Wed, 17 Jan 2018 14:16:37 +0200 Subject: [PATCH] Fix docs for Sphinx 1.6.6 rename included files to not have ".rst" extension, otherwise they are being scanned for ref targets and found targets are effectively counted twice (both in file that includes, and in the file being included), producing a warning/error. Change-Id: I2eec5b1b16d253998f45e6f0551a92c2ab6f5609 Closes-Bug: #1743780 --- doc/source/install/advanced.rst | 16 ++++++++-------- .../include/{boot-mode.rst => boot-mode.inc} | 0 ...common-configure.rst => common-configure.inc} | 0 ...rerequisites.rst => common-prerequisites.inc} | 0 ...sgi.rst => configure-ironic-api-mod_wsgi.inc} | 0 ...e-ironic-api.rst => configure-ironic-api.inc} | 0 ...ductor.rst => configure-ironic-conductor.inc} | 0 .../install/include/{console.rst => console.inc} | 0 .../include/{disk-label.rst => disk-label.inc} | 0 ...parameters.rst => kernel-boot-parameters.inc} | 0 ...mages.rst => local-boot-partition-images.inc} | 0 .../{notifications.rst => notifications.inc} | 0 ...ot-device-hints.rst => root-device-hints.inc} | 0 .../{trusted-boot.rst => trusted-boot.inc} | 0 doc/source/install/install-obs.rst | 10 +++++----- doc/source/install/install-rdo.rst | 10 +++++----- doc/source/install/install-ubuntu.rst | 10 +++++----- 17 files changed, 23 insertions(+), 23 deletions(-) rename doc/source/install/include/{boot-mode.rst => boot-mode.inc} (100%) rename doc/source/install/include/{common-configure.rst => common-configure.inc} (100%) rename doc/source/install/include/{common-prerequisites.rst => common-prerequisites.inc} (100%) rename doc/source/install/include/{configure-ironic-api-mod_wsgi.rst => configure-ironic-api-mod_wsgi.inc} (100%) rename doc/source/install/include/{configure-ironic-api.rst => configure-ironic-api.inc} (100%) rename doc/source/install/include/{configure-ironic-conductor.rst => configure-ironic-conductor.inc} (100%) rename doc/source/install/include/{console.rst => console.inc} (100%) rename doc/source/install/include/{disk-label.rst => disk-label.inc} (100%) rename doc/source/install/include/{kernel-boot-parameters.rst => kernel-boot-parameters.inc} (100%) rename doc/source/install/include/{local-boot-partition-images.rst => local-boot-partition-images.inc} (100%) rename doc/source/install/include/{notifications.rst => notifications.inc} (100%) rename doc/source/install/include/{root-device-hints.rst => root-device-hints.inc} (100%) rename doc/source/install/include/{trusted-boot.rst => trusted-boot.inc} (100%) diff --git a/doc/source/install/advanced.rst b/doc/source/install/advanced.rst index fc0c1461ef..bc9f73e4bf 100644 --- a/doc/source/install/advanced.rst +++ b/doc/source/install/advanced.rst @@ -3,18 +3,18 @@ Advanced features ================= -.. include:: include/local-boot-partition-images.rst +.. include:: include/local-boot-partition-images.inc -.. include:: include/root-device-hints.rst +.. include:: include/root-device-hints.inc -.. include:: include/kernel-boot-parameters.rst +.. include:: include/kernel-boot-parameters.inc -.. include:: include/boot-mode.rst +.. include:: include/boot-mode.inc -.. include:: include/disk-label.rst +.. include:: include/disk-label.inc -.. include:: include/trusted-boot.rst +.. include:: include/trusted-boot.inc -.. include:: include/notifications.rst +.. include:: include/notifications.inc -.. include:: include/console.rst +.. include:: include/console.inc diff --git a/doc/source/install/include/boot-mode.rst b/doc/source/install/include/boot-mode.inc similarity index 100% rename from doc/source/install/include/boot-mode.rst rename to doc/source/install/include/boot-mode.inc diff --git a/doc/source/install/include/common-configure.rst b/doc/source/install/include/common-configure.inc similarity index 100% rename from doc/source/install/include/common-configure.rst rename to doc/source/install/include/common-configure.inc diff --git a/doc/source/install/include/common-prerequisites.rst b/doc/source/install/include/common-prerequisites.inc similarity index 100% rename from doc/source/install/include/common-prerequisites.rst rename to doc/source/install/include/common-prerequisites.inc diff --git a/doc/source/install/include/configure-ironic-api-mod_wsgi.rst b/doc/source/install/include/configure-ironic-api-mod_wsgi.inc similarity index 100% rename from doc/source/install/include/configure-ironic-api-mod_wsgi.rst rename to doc/source/install/include/configure-ironic-api-mod_wsgi.inc diff --git a/doc/source/install/include/configure-ironic-api.rst b/doc/source/install/include/configure-ironic-api.inc similarity index 100% rename from doc/source/install/include/configure-ironic-api.rst rename to doc/source/install/include/configure-ironic-api.inc diff --git a/doc/source/install/include/configure-ironic-conductor.rst b/doc/source/install/include/configure-ironic-conductor.inc similarity index 100% rename from doc/source/install/include/configure-ironic-conductor.rst rename to doc/source/install/include/configure-ironic-conductor.inc diff --git a/doc/source/install/include/console.rst b/doc/source/install/include/console.inc similarity index 100% rename from doc/source/install/include/console.rst rename to doc/source/install/include/console.inc diff --git a/doc/source/install/include/disk-label.rst b/doc/source/install/include/disk-label.inc similarity index 100% rename from doc/source/install/include/disk-label.rst rename to doc/source/install/include/disk-label.inc diff --git a/doc/source/install/include/kernel-boot-parameters.rst b/doc/source/install/include/kernel-boot-parameters.inc similarity index 100% rename from doc/source/install/include/kernel-boot-parameters.rst rename to doc/source/install/include/kernel-boot-parameters.inc diff --git a/doc/source/install/include/local-boot-partition-images.rst b/doc/source/install/include/local-boot-partition-images.inc similarity index 100% rename from doc/source/install/include/local-boot-partition-images.rst rename to doc/source/install/include/local-boot-partition-images.inc diff --git a/doc/source/install/include/notifications.rst b/doc/source/install/include/notifications.inc similarity index 100% rename from doc/source/install/include/notifications.rst rename to doc/source/install/include/notifications.inc diff --git a/doc/source/install/include/root-device-hints.rst b/doc/source/install/include/root-device-hints.inc similarity index 100% rename from doc/source/install/include/root-device-hints.rst rename to doc/source/install/include/root-device-hints.inc diff --git a/doc/source/install/include/trusted-boot.rst b/doc/source/install/include/trusted-boot.inc similarity index 100% rename from doc/source/install/include/trusted-boot.rst rename to doc/source/install/include/trusted-boot.inc diff --git a/doc/source/install/install-obs.rst b/doc/source/install/install-obs.rst index 067913f191..be50d39cac 100644 --- a/doc/source/install/install-obs.rst +++ b/doc/source/install/install-obs.rst @@ -12,7 +12,7 @@ for openSUSE Leap 42.2 and SUSE Linux Enterprise Server 12 SP2. Server is not officially supported. Nevertheless, installation should be possible. -.. include:: include/common-prerequisites.rst +.. include:: include/common-prerequisites.inc Install and configure components ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -30,10 +30,10 @@ Install and configure components # systemctl enable openstack-ironic-api openstack-ironic-conductor # systemctl start openstack-ironic-api openstack-ironic-conductor -.. include:: include/common-configure.rst +.. include:: include/common-configure.inc -.. include:: include/configure-ironic-api.rst +.. include:: include/configure-ironic-api.inc -.. include:: include/configure-ironic-api-mod_wsgi.rst +.. include:: include/configure-ironic-api-mod_wsgi.inc -.. include:: include/configure-ironic-conductor.rst +.. include:: include/configure-ironic-conductor.inc diff --git a/doc/source/install/install-rdo.rst b/doc/source/install/install-rdo.rst index 1c2d082148..ccf3fc1331 100644 --- a/doc/source/install/install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -8,7 +8,7 @@ Install and configure for Red Hat Enterprise Linux and CentOS This section describes how to install and configure the Bare Metal service for Red Hat Enterprise Linux 7 and CentOS 7. -.. include:: include/common-prerequisites.rst +.. include:: include/common-prerequisites.inc Install and configure components ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -34,10 +34,10 @@ Install and configure components # systemctl enable openstack-ironic-api openstack-ironic-conductor # systemctl start openstack-ironic-api openstack-ironic-conductor -.. include:: include/common-configure.rst +.. include:: include/common-configure.inc -.. include:: include/configure-ironic-api.rst +.. include:: include/configure-ironic-api.inc -.. include:: include/configure-ironic-api-mod_wsgi.rst +.. include:: include/configure-ironic-api-mod_wsgi.inc -.. include:: include/configure-ironic-conductor.rst +.. include:: include/configure-ironic-conductor.inc diff --git a/doc/source/install/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst index 28dbd6b035..92c8fc6d31 100644 --- a/doc/source/install/install-ubuntu.rst +++ b/doc/source/install/install-ubuntu.rst @@ -7,7 +7,7 @@ Install and configure for Ubuntu This section describes how to install and configure the Bare Metal service for Ubuntu 14.04 (LTS). -.. include:: include/common-prerequisites.rst +.. include:: include/common-prerequisites.inc Install and configure components ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -22,10 +22,10 @@ Install and configure components Services are enabled by default on Ubuntu. -.. include:: include/common-configure.rst +.. include:: include/common-configure.inc -.. include:: include/configure-ironic-api.rst +.. include:: include/configure-ironic-api.inc -.. include:: include/configure-ironic-api-mod_wsgi.rst +.. include:: include/configure-ironic-api-mod_wsgi.inc -.. include:: include/configure-ironic-conductor.rst +.. include:: include/configure-ironic-conductor.inc