summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* turn on warning-is-error in doc buildDong Ma2017-07-031-2/+2
| | | | Change-Id: I0b64c644f40a2da3242274194d1a5d2858813c25
* switch from oslosphinx to openstackdocsthemeDong Ma2017-07-011-2/+9
| | | | Change-Id: I66319c2b4e4ec4c10133151f7a867bdca7a3afa8
* rearrange content to fit the new standard layout4.24.0Dong Ma2017-07-0110-15/+33
| | | | | Change-Id: Idaa0dde5e4fd14213ae1611560897a27e9f72514 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
* docs: mention that it's possible to use Connection directlyRoman Podoliaka2016-12-121-0/+15
| | | | | | | | Sometimes people just do not need the ORM part and a Session at all. Mention the fact, that it's possible to ask for a Connection in enginefacade. Change-Id: I7a135be7149cd3fa140e0268fea5a17f23f402b2
* Make it possible to use enginefacade decorators with class methodsRoman Podoliaka2016-06-271-2/+25
| | | | | | | | | | | | | | The decorator form can now be used with bound methods after a fix for the related bug was merged. Mention this in docs and release notes, so that people are aware of it. A new test is added to make sure this also works with class methods (as well as to check that the proposed decorator applying order is actually correct). Related-Bug: #1520195 Change-Id: Ifea08114d6d89de9d67fcae397eb94c0afc4d339
* Fix imports in docThomas Herve2016-05-221-4/+4
| | | | | | | This fixes some imports in the usage docs that still uses the oslo namespace package. Change-Id: I684082ec2895704afd3282334547043dcd2da1f9
* Remove oslo-incubator related stuffChangBo Guo(gcb)2016-05-111-1/+0
| | | | Change-Id: I4f09eb32cbc461e8aa8cb0df4612730d02e46dda
* Correct invalid referenceBrant Knudson2015-09-281-1/+1
| | | | | | | There's no oslo_db.migration module. It's an entrypoint group name. Therefore it should not be using :mod:. Change-Id: I14f26c1a9ae1bd6b5b1154b3f49eb9e1518cafc3
* Use stevedore directive to document pluginsAllison Randal2015-09-252-1/+10
| | | | | | | Add directives to the documentation to bring in the docstrings from the plugins. Change-Id: I2afe1d1e4a9abfa1d3cdf85bc4008ff8f772123c
* Merge "Make readme and documentation titles consistent"Jenkins2015-09-251-7/+6
|\
| * Make readme and documentation titles consistentDoug Hellmann2015-09-241-7/+6
| | | | | | | | Change-Id: Ic667d7d7a4cb4a0fb3e6d15cc243f89b510386db
* | Merge "Autogenerate the module docs"Jenkins2015-09-2415-112/+6
|\ \
| * | Autogenerate the module docsBrant Knudson2015-09-2415-112/+6
| |/ | | | | | | | | | | | | | | | | | | The module docs were out of date (sqlalchemy.enginefacade was missing). Rather than try to keep this up to date by hand, autogenerate the module docs. Change-Id: I9b36cc635c1c0af9a61b5da20205f5628aec97e7
* | Add config options to the documentationDavanum Srinivas2015-09-243-0/+11
|/ | | | | | | Add the directive to include the configuration options to the library documentation. Change-Id: I085cf62213340e19a2fa39b909b5c0365226f059
* Fix hacking rules and docs jobDavanum Srinivas2015-08-081-1/+1
| | | | Change-Id: I2d86f266165ad98ded9f0bb9f11abfd8aa2c09ef
* Improve failure mode handling in enginefacadeMike Bayer2015-07-271-0/+6
| | | | | | | | | | | | | | | | | | | | Check explicitly for the cases where no "sql_connection" attribute was set when running _start(), so that the lack of this parameter is documented by the exception rather than failing into create_engine() with an unclear failure mode. If _start() fails as it will here, make sure _started stays False so that repeated calls to _start() continue to raise the same exception, rather than raising attribute errors. When accessing the "session" or "connection" attributes of the context when these attributes were not requested by the decorator or context manager, raise explicit exceptions for each, rather than returning None which leads to hard-to-debug NoneType errors. Change-Id: Iadfbf4707daed4140285a3a472009f6863b18275 Closes-bug: 1477080
* Switch from MySQL-python to PyMySQLJeremy Stanley2015-06-181-4/+25
| | | | | | | | | | | | | As discussed in the Liberty Design Summit "Moving apps to Python 3" cross-project workshop, the way forward in the near future is to switch to the pure-python PyMySQL library as a default. Added a special test environment to keep MySQL-python support. Documentation modified. https://etherpad.openstack.org/p/liberty-cross-project-python3 Change-Id: I12b32dc097a121bd43991bc38dd4d289b65e86c1
* Implement new oslo.db.sqlalchemy.enginefacade moduleMike Bayer2015-06-041-14/+79
| | | | | | | | | | | | | | | | | | | | | | | | This module presents a replacement for the EngineFacade system. At the center is the oslo.db.sqlalchemy.enginefacade module, which when imported, provides decorators and context managers which perform all database and ORM connectivity functions transparently. The docstrings as well as the blueprint provide an introduction. The patch includes a refactoring of sqlalchemy/session.py into three dependent modules engines.py, orm.py and enginefacade.py. This is to maintain a non-cyclical import structure as well as to maintain the import behavior of oslo.db overall, as some projects such as glance currently have dependencies on this structure. There is also a slimming down and attempt at modernizing some very old documentation in session.py. The enginefacade system should be preferred moving forward. Implements: blueprint make-enginefacade-a-facade Change-Id: I9a3d0c26bb727eb2c0bd823b9a12fde57cc7c9c3
* Add pypi download + version badgesJoshua Harlow2015-04-071-9/+15
| | | | | | | | Also makes the docs look more like the other oslo libraries so that the content is easily readable across projects. Change-Id: Idb17dd30403daa130176643f4609fdd7c61c076e
* Move files out of the namespace packageDoug Hellmann2014-12-2412-23/+23
| | | | | | | | | | Move the public API out of oslo.db to oslo_db. Retain the ability to import from the old namespace package for backwards compatibility for this release cycle. Blueprint: drop-namespace-packages Change-Id: Ie96b482b9fbcb1d85203ad35bb65c1f43e912a44
* Clean up documentationDoug Hellmann2014-09-0418-23/+131
| | | | | | | | | | | | | | | | | Switch to manually generated rst files for the API documentation so we do not expose private parts of the library. Fix formatting of usage.rst Convert bullet list to section headers to fix rendering issues and make the docs more readable. Fix formatting of docstrings in classes exposed in the docs to eliminate warnings/errors from Sphinx. Add history.rst Change-Id: I6f500775f801558f7c0c29f180b60f83a7150e02
* Add doc8 to tox environment docsChristian Berendt2014-09-011-3/+3
| | | | | | Check reStructuredText documents for common style issues. Change-Id: I10e61742e86d2d4781c5a00532c8e17d38a7d4b4
* Merge "remove definitions of Python Source Code Encoding"Jenkins2014-07-301-1/+0
|\
| * remove definitions of Python Source Code EncodingChristian Berendt2014-05-251-2/+1
| | | | | | | | | | | | | | I think PEP 0263 (http://legacy.python.org/dev/peps/pep-0263/) is not used anywhere else and so it should be removed. Change-Id: Ic2c2b284cc80e3db4380fda6f81d45f6d57f2d02
* | Merge "Adding dependency documentation for MySQL."Jenkins2014-06-141-3/+24
|\ \
| * | Adding dependency documentation for MySQL.Tim Kelsey2014-06-131-3/+24
| | | | | | | | | | | | | | | | | | | | | | | | | | | Merging change I347e1c235bc82d6e510761f4b1c3c3de62994c2f fixing pip info. Co-Authored-By: Gauvain Pocentek <gauvain.pocentek@objectif-libre.com> Change-Id: I9a1b76ed261c69a92cc3e4e6b6100e43f98fea1e
* | | Merge "Added ``docs`` environment to tox.ini"Jenkins2014-06-103-5/+17
|\ \ \
| * | | Added ``docs`` environment to tox.iniVictor Sergeyev2014-06-063-5/+17
| |/ / | | | | | | | | | | | | | | | | | | Added the new tox environment to build docs. Fixes in oslo.db documentation building Change-Id: Icab4f299df3d8a4c40dc4fd7292609109f206afd
* | | Merge "Fix usage of oslo.config"Jenkins2014-06-051-5/+3
|\ \ \ | |/ / |/| |
| * | Fix usage of oslo.configRoman Podoliaka2014-05-271-5/+3
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - make it possible to create a DBAPI instance given a config instance - remove usage of global cfg.CONF instance (it's up to a user to pass a ConfigOpts instance to oslo.db) - ensure end applications don't need to import/register/use config options directly - instead they pass a config instance to oslo.db helpers (EngineFacade.from_config() and DBAPI.from_config() class methods) At the same time, usage of oslo.config remains completely optional as we provide an API to pass those parameters programatically. Change-Id: I1a00db7a4200ebdc96f17256ecbad430477e868f
* | cleaning up index.rst fileChristian Berendt2014-05-281-7/+2
|/ | | | | | Removed notes about the generation of the file and fixed the title. Change-Id: If4d31f80c63f32b33f6f6a13d39fa12992fcf96c
* Fix dhellmann's notes from April 18Victor Sergeyev2014-04-221-2/+62
| | | | | | | | | | | removed the python 3 classifier. See note https://github.com/malor/oslo.db/commit/e4cfa6d39d2aa53af64ab34de97183f98fbeb667#commitcomment-6058177 added W292 pep8 check. See note https://github.com/malor/oslo.db/commit/276f7570d7af4a7a62d0e1ffb4edf904cfbf0600#commitcomment-6058296 added usage examples. See note https://github.com/malor/oslo.db/commit/e4cfa6d39d2aa53af64ab34de97183f98fbeb667#commitcomment-6058130
* Fix the graduate.sh script resultVictor Sergeyev2014-04-186-0/+120
View Lorry Controller Status