openstack/openstack-manuals
Code Issues Proposed changes

Error out on warnings when building RST

Browse Source 
Treat warnings as errors when building RST.

Fix warning about wrong reference in sdk files and about
file not included anywhere.

Change-Id: I3cfd054b6bacc205991e2f57795d183a21275c21
This commit is contained in:
Andreas Jaeger
2015-02-23 13:31:55 +01:00
parent 042d11ab4e
commit 752ec2d669
4 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/playground-user-guide/source/sdk.rst
View File

@@ -24,4 +24,4 @@ You should also be familiar with:
sdk_configure_access_security_instances.rst sdk_configure_access_security_instances.rst
sdk_authenticate_networking_endpoint.rst sdk_authenticate_networking_endpoint.rst
sdk_authenticate_compute_output.rst sdk_authenticate_compute_output.rst
.. add sdk_assign_cors_headers.rst when migrated TODO(DC) sdk_assign_cors_headers.rst

2
doc/playground-user-guide/source/sdk_authenticate.rst
View File

@@ -1,3 +1,5 @@
.. _sdk_authenticate:
============ ============
Authenticate Authenticate
============ ============

2
doc/playground-user-guide/source/sdk_authenticate_compute_output.rst
View File

@@ -9,7 +9,7 @@ Set environment variables
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
To set up environmental variables and authenticate against Compute API To set up environmental variables and authenticate against Compute API
endpoints, see :ref:`Authenticate <sdk_authenticate.rst>`. endpoints, see :ref:`Authenticate <sdk_authenticate>`.
.. _get-openstack-credentials: .. _get-openstack-credentials:

10
tox.ini
View File

@@ -45,10 +45,10 @@ commands =
python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/ python tools/www-generator.py --source-directory www/ --output-directory publish-docs/www/
cp www/www-index.html publish-docs/ cp www/www-index.html publish-docs/
rsync -a www/static/ publish-docs/www/ 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/ mkdir -p publish-docs/playground-user-guide/content/
rsync -a doc/playground-user-guide/build/html/ 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/ mkdir -p publish-docs/networking-guide/content/
rsync -a doc/networking-guide/build/html/ publish-docs/networking-guide/content/ rsync -a doc/networking-guide/build/html/ publish-docs/networking-guide/content/
# Do not build DocBook XML Networking Guide # Do not build DocBook XML Networking Guide
@@ -56,11 +56,11 @@ commands =
[testenv:docs] [testenv:docs]
commands = commands =
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
sphinx-build doc/networking-guide/ doc/networking-guide/build/html sphinx-build -W doc/networking-guide/ doc/networking-guide/build/html
[testenv:network] [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] [testenv:publishdocs]
# Prepare all documents (except www subdir) so that they can get # Prepare all documents (except www subdir) so that they can get