openstack/oslo.db
Code Issues Proposed changes

Fix warnings in docstrings

Browse Source 
When generating the docs some warnings were generated.

Also, configure doc build so that if there are warnings, the
build will fail.

Change-Id: I7e10499294cf1f06f766cbff392e9de32ea48e5a
This commit is contained in:
Brant Knudson 2015-09-21 15:34:45 -05:00
parent 0b3aee8cc6
commit 14c955cf6d
4 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
oslo_db/sqlalchemy/enginefacade.py
View File

@ -842,7 +842,6 @@ class LegacyEngineFacade(object):
"""A helper class for removing of global engine instances from oslo.db.
.. deprecated::
EngineFacade is deprecated. Please use
oslo.db.sqlalchemy.enginefacade for new development.

2
oslo_db/sqlalchemy/test_migrations.py
View File

@ -166,7 +166,7 @@ class WalkVersionsMixin(object):
If we have ordered migrations 123abc, 456def, 789ghi and we run
upgrading with the `snake_walk` argument set to `True`, the
migrations will be applied in the following order:
migrations will be applied in the following order::
`123abc => 456def => 123abc =>
456def => 789ghi => 456def => 789ghi`

4
setup.cfg
View File

@ -60,9 +60,7 @@ fixtures =
testscenarios>=0.4
[pbr]
# NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then
# want to treat sphinx warnings as errors
# warnerrors = True
warnerrors = True
autodoc_index_modules = True
autodoc_exclude_modules =
oslo_db.tests.*