diff options
| author | Brant Knudson <bknudson@us.ibm.com> | 2015-09-21 15:34:45 -0500 |
|---|---|---|
| committer | Brant Knudson <bknudson@us.ibm.com> | 2015-09-24 10:56:06 -0500 |
| commit | 14c955cf6d4b673a6612fb8f3463bb275cc9fcd7 (patch) | |
| tree | ecaca75b5dfb89a871d15878438089e68474ca41 | |
| parent | 0b3aee8cc6d5c373bcba74330f0fea8f0e4e4b26 (diff) | |
| download | oslo-db-14c955cf6d4b673a6612fb8f3463bb275cc9fcd7.tar.gz | |
Fix warnings in docstrings
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
| -rw-r--r-- | oslo_db/options.py | 6 | ||||
| -rw-r--r-- | oslo_db/sqlalchemy/enginefacade.py | 1 | ||||
| -rw-r--r-- | oslo_db/sqlalchemy/test_migrations.py | 2 | ||||
| -rw-r--r-- | setup.cfg | 4 |
4 files changed, 5 insertions, 8 deletions
diff --git a/oslo_db/options.py b/oslo_db/options.py index 42de948..5d8f74c 100644 --- a/oslo_db/options.py +++ b/oslo_db/options.py @@ -152,9 +152,9 @@ def set_defaults(conf, connection=None, sqlite_db=None, :keyword connection: SQL connection string. Valid SQLite URL forms are: - * sqlite:///:memory: (or, sqlite://) - * sqlite:///relative/path/to/file.db - * sqlite:////absolute/path/to/file.db + * sqlite:///:memory: (or, sqlite://) + * sqlite:///relative/path/to/file.db + * sqlite:////absolute/path/to/file.db :type connection: str :keyword sqlite_db: path to SQLite database file. diff --git a/oslo_db/sqlalchemy/enginefacade.py b/oslo_db/sqlalchemy/enginefacade.py index 8b241cf..9243351 100644 --- a/oslo_db/sqlalchemy/enginefacade.py +++ b/oslo_db/sqlalchemy/enginefacade.py @@ -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. diff --git a/oslo_db/sqlalchemy/test_migrations.py b/oslo_db/sqlalchemy/test_migrations.py index 627e563..9e0f643 100644 --- a/oslo_db/sqlalchemy/test_migrations.py +++ b/oslo_db/sqlalchemy/test_migrations.py @@ -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` @@ -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.*
\ No newline at end of file |