Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. There are some invalid docstrings. These are cleaned up. Change-Id: Ic6a028bab428b23255f36e5b2d64ee8d4d32978d
This commit is contained in:
parent
3951771456
commit
886d8c6dab
@ -127,10 +127,11 @@ attributes obtained through a token:
|
||||
- domain_id or project_id (depending on the token scope)
|
||||
- list of roles held for the given token scope
|
||||
|
||||
.. note:: Some resources which are exposed by the API do not support policy
|
||||
enforcement by user_id, and only support policy enforcement by project_id.
|
||||
Some global resources do not support policy enforcement by combination of
|
||||
user_id and project_id.
|
||||
.. note::
|
||||
Some resources which are exposed by the API do not support policy
|
||||
enforcement by user_id, and only support policy enforcement by project_id.
|
||||
Some global resources do not support policy enforcement by combination of
|
||||
user_id and project_id.
|
||||
|
||||
For example, a check on the user_id would be defined as::
|
||||
|
||||
@ -204,10 +205,10 @@ using the :func:`~oslo_policy.policy.register` function.
|
||||
|
||||
The following classes can be used as parents for custom special check types:
|
||||
|
||||
* :class:`~oslo_policy.policy.AndCheck`
|
||||
* :class:`~oslo_policy.policy.NotCheck`
|
||||
* :class:`~oslo_policy.policy.OrCheck`
|
||||
* :class:`~oslo_policy.policy.RuleCheck`
|
||||
* :class:`~oslo_policy.policy.AndCheck`
|
||||
* :class:`~oslo_policy.policy.NotCheck`
|
||||
* :class:`~oslo_policy.policy.OrCheck`
|
||||
* :class:`~oslo_policy.policy.RuleCheck`
|
||||
|
||||
Default Rule
|
||||
~~~~~~~~~~~~
|
||||
@ -851,11 +852,12 @@ class DocumentedRuleDefault(RuleDefault):
|
||||
converted to use DocumentedRuleDefault.
|
||||
|
||||
:param operations: List of dicts containing each api url and
|
||||
corresponding http request method.
|
||||
corresponding http request method.
|
||||
|
||||
Example:
|
||||
operations=[{'path': '/foo', 'method': 'GET'},
|
||||
{'path': '/some', 'method': 'POST'}]
|
||||
Example::
|
||||
|
||||
operations=[{'path': '/foo', 'method': 'GET'},
|
||||
{'path': '/some', 'method': 'POST'}]
|
||||
"""
|
||||
def __init__(self, name, check_str, description, operations):
|
||||
super(DocumentedRuleDefault, self).__init__(
|
||||
|
@ -23,8 +23,10 @@ packages =
|
||||
oslo_policy
|
||||
|
||||
[pbr]
|
||||
warnerrors = true
|
||||
autodoc_tree_index_modules = True
|
||||
autodoc_tree_excludes =
|
||||
setup.py
|
||||
oslo_policy/tests/
|
||||
|
||||
[entry_points]
|
||||
oslo.config.opts =
|
||||
@ -37,9 +39,10 @@ console_scripts =
|
||||
oslopolicy-list-redundant = oslo_policy.generator:list_redundant
|
||||
|
||||
[build_sphinx]
|
||||
all-files = 1
|
||||
warning-is-error = 1
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
Loading…
Reference in New Issue
Block a user