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 two issues: - The `*` character is recognized as an emphasis character and must be escaped - The index references modules that have since been removed These are resolved. Change-Id: Id078022c0f75bf8f162b693d260f67116eb6428b
This commit is contained in:
parent
bd99002339
commit
6e04f882c4
@ -24,8 +24,6 @@ API Documentation
|
|||||||
api/excutils
|
api/excutils
|
||||||
api/fileutils
|
api/fileutils
|
||||||
api/fixture
|
api/fixture
|
||||||
api/fnmatch
|
|
||||||
api/imageutils
|
|
||||||
api/importutils
|
api/importutils
|
||||||
api/netutils
|
api/netutils
|
||||||
api/reflection
|
api/reflection
|
||||||
|
@ -323,16 +323,16 @@ def mask_dict_password(dictionary, secret="***"): # nosec
|
|||||||
A dictionary (which may contain nested dictionaries) contains
|
A dictionary (which may contain nested dictionaries) contains
|
||||||
information (such as passwords) which should not be revealed, and
|
information (such as passwords) which should not be revealed, and
|
||||||
this function helps detect and replace those with the 'secret'
|
this function helps detect and replace those with the 'secret'
|
||||||
provided (or '***' if none is provided).
|
provided (or `***` if none is provided).
|
||||||
|
|
||||||
Substitution is performed in one of three situations:
|
Substitution is performed in one of three situations:
|
||||||
|
|
||||||
If the key is something that is considered to be indicative of a
|
If the key is something that is considered to be indicative of a
|
||||||
secret, then the corresponding value is replaced with the secret
|
secret, then the corresponding value is replaced with the secret
|
||||||
provided (or '***' if none is provided).
|
provided (or `***` if none is provided).
|
||||||
|
|
||||||
If a value in the dictionary is a string, then it is masked
|
If a value in the dictionary is a string, then it is masked
|
||||||
using the mask_password() function.
|
using the ``mask_password()`` function.
|
||||||
|
|
||||||
Finally, if a value is a dictionary, this function will
|
Finally, if a value is a dictionary, this function will
|
||||||
recursively mask that dictionary as well.
|
recursively mask that dictionary as well.
|
||||||
|
@ -22,13 +22,11 @@ classifier =
|
|||||||
packages =
|
packages =
|
||||||
oslo_utils
|
oslo_utils
|
||||||
|
|
||||||
[pbr]
|
|
||||||
warnerrors = true
|
|
||||||
|
|
||||||
[build_sphinx]
|
[build_sphinx]
|
||||||
|
all-files = 1
|
||||||
|
warning-is-error = 1
|
||||||
source-dir = doc/source
|
source-dir = doc/source
|
||||||
build-dir = doc/build
|
build-dir = doc/build
|
||||||
all_files = 1
|
|
||||||
|
|
||||||
[upload_sphinx]
|
[upload_sphinx]
|
||||||
upload-dir = doc/build/html
|
upload-dir = doc/build/html
|
||||||
|
Loading…
x
Reference in New Issue
Block a user