Introducing warning-is-error to docs

Change-Id: I113d257de132278802e8815159ef99f0afaf38e4
This commit is contained in:
dparalen 2017-07-18 14:08:45 +02:00
parent 25af8ac28e
commit 875a8c1d3d
2 changed files with 3 additions and 2 deletions

View File

@ -285,7 +285,7 @@ class ClientV1(http.BaseClient):
:param node_ident: node UUID or name
:param interface: interface name
:param field_sel: list of all fields for which to get data
:returns interface data in OrderedDict
:returns: interface data in OrderedDict
"""
# Use OrderedDict to maintain order of user-entered fields
iface_data = OrderedDict()
@ -323,7 +323,7 @@ class ClientV1(http.BaseClient):
:param node_ident: node UUID or name
:param field_sel: list of all fields for which to get data
:param vlan: list of vlans used to filter the lists returned
:returns list of interface data, each interface in a list
:returns: list of interface data, each interface in a list
"""
# Get inventory data for this node

View File

@ -50,6 +50,7 @@ api_doc_dir = reference/api
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[extras]
cli =