From 752ec2d669b69f118eac7ae33e312c2f063c28ca Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 23 Feb 2015 13:31:55 +0100 Subject: [PATCH] Error out on warnings when building RST Treat warnings as errors when building RST. Fix warning about wrong reference in sdk files and about file not included anywhere. Change-Id: I3cfd054b6bacc205991e2f57795d183a21275c21 --- doc/playground-user-guide/source/sdk.rst | 2 +- doc/playground-user-guide/source/sdk_authenticate.rst | 2 ++ .../source/sdk_authenticate_compute_output.rst | 2 +- tox.ini | 10 +++++----- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/doc/playground-user-guide/source/sdk.rst b/doc/playground-user-guide/source/sdk.rst index fef0d9fbda..3554238d17 100644 --- a/doc/playground-user-guide/source/sdk.rst +++ b/doc/playground-user-guide/source/sdk.rst @@ -24,4 +24,4 @@ You should also be familiar with: sdk_configure_access_security_instances.rst sdk_authenticate_networking_endpoint.rst sdk_authenticate_compute_output.rst -.. add sdk_assign_cors_headers.rst when migrated TODO(DC) + sdk_assign_cors_headers.rst diff --git a/doc/playground-user-guide/source/sdk_authenticate.rst b/doc/playground-user-guide/source/sdk_authenticate.rst index fa3ec1b50e..d7e9c4ee4b 100644 --- a/doc/playground-user-guide/source/sdk_authenticate.rst +++ b/doc/playground-user-guide/source/sdk_authenticate.rst @@ -1,3 +1,5 @@ +.. _sdk_authenticate: + ============ Authenticate ============ diff --git a/doc/playground-user-guide/source/sdk_authenticate_compute_output.rst b/doc/playground-user-guide/source/sdk_authenticate_compute_output.rst index eb9b38314f..2ef80953c7 100644 --- a/doc/playground-user-guide/source/sdk_authenticate_compute_output.rst +++ b/doc/playground-user-guide/source/sdk_authenticate_compute_output.rst @@ -9,7 +9,7 @@ Set environment variables ~~~~~~~~~~~~~~~~~~~~~~~~~ To set up environmental variables and authenticate against Compute API -endpoints, see :ref:`Authenticate `. +endpoints, see :ref:`Authenticate `. .. _get-openstack-credentials: diff --git a/tox.ini b/tox.ini index c022be7ea9..44a46f9646 100644 --- a/tox.ini +++ b/tox.ini @@ -45,10 +45,10 @@ commands = python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/ cp www/www-index.html publish-docs/ rsync -a www/static/ publish-docs/www/ - sphinx-build doc/playground-user-guide/source/ doc/playground-user-guide/build/html + sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html mkdir -p publish-docs/playground-user-guide/content/ rsync -a doc/playground-user-guide/build/html/ publish-docs/playground-user-guide/content/ - sphinx-build doc/networking-guide/ doc/networking-guide/build/html + sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html mkdir -p publish-docs/networking-guide/content/ rsync -a doc/networking-guide/build/html/ publish-docs/networking-guide/content/ # Do not build DocBook XML Networking Guide @@ -56,11 +56,11 @@ commands = [testenv:docs] commands = - sphinx-build doc/playground-user-guide/source/ doc/playground-user-guide/build/html - sphinx-build doc/networking-guide/ doc/networking-guide/build/html + sphinx-build -W doc/playground-user-guide/source/ doc/playground-user-guide/build/html + sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html [testenv:network] -commands = sphinx-build doc/networking-guide/ doc/networking-guide/build/html +commands = sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html [testenv:publishdocs] # Prepare all documents (except www subdir) so that they can get