openstack/designate
Code Issues Proposed changes

Fix all doc warnings and enforce clean docs

Browse Source 
* Fixes all doc warnings and errors
* Updates tox.ini to run sphinx with "fail on warnings"
  enabled.

Change-Id: I188733aa5a9de072c52da7269af22c5c1361ec29
This commit is contained in:
Kiall Mac Innes 2016-04-14 20:32:36 +01:00
parent ddf8a03145
commit 4735d2301f
6 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/architecture.rst
View File

@ -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. 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: .. _dns-backend:

1
doc/source/conf.py
View File

@ -16,6 +16,7 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # 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('../'))
sys.path.insert(0, os.path.abspath('./')) sys.path.insert(0, os.path.abspath('./'))

2
doc/source/install/ubuntu-kilo.rst
View File

@ -17,8 +17,6 @@
Installing Kilo on Ubuntu Installing Kilo on Ubuntu
************************* *************************
.. _Development Environment:
Development Environment Development Environment
+++++++++++++++++++++++ +++++++++++++++++++++++

2
doc/source/rest/v2/tsigkeys.rst
View File

@ -164,6 +164,8 @@ Get Tsigkey
**Example response:** **Example response:**
.. sourcecode:: http
Content-Length: 350 Content-Length: 350
Content-Type: application/json; charset=UTF-8 Content-Type: application/json; charset=UTF-8
X-Openstack-Request-Id: req-d8cd7f24-a735-400b-9a4b-79e175efc923 X-Openstack-Request-Id: req-d8cd7f24-a735-400b-9a4b-79e175efc923

6
doc/source/rest/v2/zones.rst
View File

@ -777,8 +777,7 @@ List Zone Imports
"status": "COMPLETE", "status": "COMPLETE",
"zone_id": 047888ee-e9dd-4c08-8b44-ab2e879e01bd, "zone_id": 047888ee-e9dd-4c08-8b44-ab2e879e01bd,
"links": { "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" "href": "http://127.0.0.1:9001/v2/zones/047888ee-e9dd-4c08-8b44-ab2e879e01bd"
}, },
"created_at": "2016-04-05T06:03:06.000000", "created_at": "2016-04-05T06:03:06.000000",
@ -792,8 +791,7 @@ List Zone Imports
"status": "COMPLETE", "status": "COMPLETE",
"zone_id": 68a17870-7f81-470a-b5e9-2753460fd6dc, "zone_id": 68a17870-7f81-470a-b5e9-2753460fd6dc,
"links": { "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" "href": "http://127.0.0.1:9001/v2/zones/68a17870-7f81-470a-b5e9-2753460fd6dc"
}, },
"created_at": "2016-04-05T06:06:26.000000", "created_at": "2016-04-05T06:06:26.000000",

3
tox.ini
View File

@ -32,7 +32,8 @@ commands =
ostestr --blacklist_file=tests-py3.txt ostestr --blacklist_file=tests-py3.txt
[testenv:docs] [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] [testenv:cover]
commands = python setup.py testr --coverage --testr-args='{posargs}' commands = python setup.py testr --coverage --testr-args='{posargs}'