From 4735d2301fcce0270ee1659e9ac516c30d8aa2e0 Mon Sep 17 00:00:00 2001 From: Kiall Mac Innes Date: Thu, 14 Apr 2016 20:32:36 +0100 Subject: [PATCH] Fix all doc warnings and enforce clean docs * Fixes all doc warnings and errors * Updates tox.ini to run sphinx with "fail on warnings" enabled. Change-Id: I188733aa5a9de072c52da7269af22c5c1361ec29 --- doc/source/architecture.rst | 2 +- doc/source/conf.py | 1 + doc/source/install/ubuntu-kilo.rst | 2 -- doc/source/rest/v2/tsigkeys.rst | 2 ++ doc/source/rest/v2/zones.rst | 6 ++---- tox.ini | 3 ++- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 6c67ced28..d0e1d0208 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -59,7 +59,7 @@ Designate Sink ----------------------- designate-sink is an optional service which listens for event notifications, such as compute.instance.create.end, handlers are available for Nova and Neutron. Notification events can then be used to trigger record creation & deletion. -The current sink implementations generate simple forward lookup A records, using a format specified in :ref:`handler-nova` configuration. Any field in the event notification can be used to generate a record. +The current sink implementations generate simple forward lookup A records, using a format specified in handler-nova configuration. Any field in the event notification can be used to generate a record. .. _dns-backend: diff --git a/doc/source/conf.py b/doc/source/conf.py index 709c2ac14..934cc1df2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -16,6 +16,7 @@ import sys, os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) sys.path.insert(0, os.path.abspath('../')) sys.path.insert(0, os.path.abspath('./')) diff --git a/doc/source/install/ubuntu-kilo.rst b/doc/source/install/ubuntu-kilo.rst index 9e2485e4c..64c8aafb8 100644 --- a/doc/source/install/ubuntu-kilo.rst +++ b/doc/source/install/ubuntu-kilo.rst @@ -17,8 +17,6 @@ Installing Kilo on Ubuntu ************************* -.. _Development Environment: - Development Environment +++++++++++++++++++++++ diff --git a/doc/source/rest/v2/tsigkeys.rst b/doc/source/rest/v2/tsigkeys.rst index cbf93577d..f1cbb22dc 100644 --- a/doc/source/rest/v2/tsigkeys.rst +++ b/doc/source/rest/v2/tsigkeys.rst @@ -164,6 +164,8 @@ Get Tsigkey **Example response:** + .. sourcecode:: http + Content-Length: 350 Content-Type: application/json; charset=UTF-8 X-Openstack-Request-Id: req-d8cd7f24-a735-400b-9a4b-79e175efc923 diff --git a/doc/source/rest/v2/zones.rst b/doc/source/rest/v2/zones.rst index 33aa75c42..2fbcfde8a 100644 --- a/doc/source/rest/v2/zones.rst +++ b/doc/source/rest/v2/zones.rst @@ -777,8 +777,7 @@ List Zone Imports "status": "COMPLETE", "zone_id": 047888ee-e9dd-4c08-8b44-ab2e879e01bd, "links": { - "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/0436a86e-ffc1-4d38-82a7-d75170fcd2a9" -, + "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/0436a86e-ffc1-4d38-82a7-d75170fcd2a9", "href": "http://127.0.0.1:9001/v2/zones/047888ee-e9dd-4c08-8b44-ab2e879e01bd" }, "created_at": "2016-04-05T06:03:06.000000", @@ -792,8 +791,7 @@ List Zone Imports "status": "COMPLETE", "zone_id": 68a17870-7f81-470a-b5e9-2753460fd6dc, "links": { - "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/f0aa4ac1-f975-46a4-b417-339acd1ea8e3" -, + "self": "http://127.0.0.1:9001/v2/zones/tasks/imports/f0aa4ac1-f975-46a4-b417-339acd1ea8e3", "href": "http://127.0.0.1:9001/v2/zones/68a17870-7f81-470a-b5e9-2753460fd6dc" }, "created_at": "2016-04-05T06:06:26.000000", diff --git a/tox.ini b/tox.ini index bf948e52f..e4bb20241 100644 --- a/tox.ini +++ b/tox.ini @@ -32,7 +32,8 @@ commands = ostestr --blacklist_file=tests-py3.txt [testenv:docs] -commands = python setup.py build_sphinx -E +commands = rm -rf doc/build + sphinx-build -E -W -b html doc/source doc/build/html [testenv:cover] commands = python setup.py testr --coverage --testr-args='{posargs}'