From e63f67c2f755a09035b7186295e7910a82245106 Mon Sep 17 00:00:00 2001 From: Clark Boylan Date: Wed, 5 Apr 2017 10:37:26 -0700 Subject: [PATCH] Fix internal doc refs to renamed section Providers no longer have "images" they have "diskimages". Update the refs to reflect that. Also bump sphinx version and enforce warnings as errors to catch these problems in the future. Change-Id: I367e36243ff928e194986cb6dc3c68e0d48bbcd0 Story: 2000790 --- doc/source/configuration.rst | 13 +++++++------ setup.cfg | 1 + test-requirements.txt | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 5d8f243ab..181cdf7a9 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -91,16 +91,16 @@ diskimages ---------- This section lists the images to be built using diskimage-builder. The -name of the diskimage is mapped to the :ref:`images` section of the -provider, to determine which providers should received uploads of each +name of the diskimage is mapped to the :ref:`provider_diskimages` section +of the provider, to determine which providers should received uploads of each image. The diskimage will be built in every format required by the providers with which it is associated. Because Nodepool needs to know which formats to build, if the diskimage will only be built if it appears in at least one provider. To remove a diskimage from the system entirely, remove all associated -entries in :ref:`images` and remove its entry from `diskimages`. All -uploads will be deleted as well as the files on disk. +entries in :ref:`provider_diskimages` and remove its entry from `diskimages`. +All uploads will be deleted as well as the files on disk. Example configuration:: @@ -155,7 +155,8 @@ Example configuration:: **required** ``name`` - Identifier to reference the disk image in :ref:`images` and :ref:`labels`. + Identifier to reference the disk image in :ref:`provider_diskimages` + and :ref:`labels`. **optional** @@ -450,7 +451,7 @@ Example configuration:: sections. ``diskimage`` - Refers to provider's diskimages, see :ref:`images`. + Refers to provider's diskimages, see :ref:`provider_diskimages`. ``min-ram`` Determine the flavor to use (e.g. ``m1.medium``, ``m1.large``, diff --git a/setup.cfg b/setup.cfg index 271dd0e5b..7066e40f4 100644 --- a/setup.cfg +++ b/setup.cfg @@ -29,3 +29,4 @@ console_scripts = source-dir = doc/source build-dir = doc/build all_files = 1 +warning-is-error = 1 diff --git a/test-requirements.txt b/test-requirements.txt index 1ca7bae8d..2db0d6967 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,7 +1,7 @@ # Nodepool uses hacking for its dependencies hacking>=0.10.2,<0.11 coverage -sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 +sphinx>=1.5.1 sphinxcontrib-programoutput fixtures>=0.3.12 mock>=1.0