diff options
| -rw-r--r-- | doc/source/conf.py | 5 | ||||
| -rw-r--r-- | ironic/api/controllers/v1/types.py | 10 | ||||
| -rw-r--r-- | setup.cfg | 1 |
3 files changed, 11 insertions, 5 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index f88619427..aaa12bb8c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -64,6 +64,11 @@ MOCK_MODULES = ['nova', 'nova.compute', 'nova.context'] for module in MOCK_MODULES: sys.modules[module] = mock.Mock() +# A list of glob-style patterns that should be excluded when looking for +# source files. They are matched against the source file names relative to the +# source directory, using slashes as directory separators on all platforms. +exclude_patterns = ['api/ironic_tempest_plugin.*'] + # -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with diff --git a/ironic/api/controllers/v1/types.py b/ironic/api/controllers/v1/types.py index 9cfe206b7..482e99326 100644 --- a/ironic/api/controllers/v1/types.py +++ b/ironic/api/controllers/v1/types.py @@ -272,20 +272,20 @@ class LocalLinkConnectionType(wtypes.UserType): """Validate and convert the input to a LocalLinkConnectionType. :param value: A dictionary of values to validate, switch_id is a MAC - address or an OpenFlow based datapath_id, switch_info is an optional - field. + address or an OpenFlow based datapath_id, switch_info is an + optional field. For example:: - { + + { 'switch_id': mac_or_datapath_id(), 'port_id': 'Ethernet3/1', 'switch_info': 'switch1' - } + } :returns: A dictionary. :raises: Invalid if some of the keys in the dictionary being validated are unknown, invalid, or some required ones are missing. - """ wtypes.DictType(wtypes.text, wtypes.text).validate(value) @@ -109,6 +109,7 @@ autodoc_index_modules = True autodoc_exclude_modules = ironic.db.sqlalchemy.alembic.env ironic.db.sqlalchemy.alembic.versions.* + ironic_tempest_plugin.* warnerrors = True [build_sphinx] |