summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove legacy calling style of select()Stephen Finucane2021-07-291-1/+1
| | | | | | | | | | | Resolve the following SADeprecationWarning warning: The legacy calling style of select() is deprecated and will be removed in SQLAlchemy 2.0. Please use the new calling style described at select(). Change-Id: Ic5f7240e790425d2689c6870483748650a49bc3d Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* remove unicode from codexuanyandong2021-01-031-1/+1
| | | | Change-Id: Ia782bc7127a1cb967e2f475065b1fb963b9c184f
* Adding pre-commitHervé Beraud2020-09-221-9/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduced changes: - pre-commit config and rules - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks. - Applying fixes for pre-commit compliance in all code. Also commit hash will be used instead of version tags in pre-commit to prevend arbitrary code from running in developer's machines. pre-commit will be used to: - trailing whitespace; - Replaces or checks mixed line ending (mixed-line-ending); - Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker); - Checks that non-binary executables have a proper shebang (check-executables-have-shebangs); - Check for files that contain merge conflict strings (check-merge-conflict); - Check for debugger imports and py37+ breakpoint() calls in python source (debug-statements); - Attempts to load all yaml files to verify syntax (check-yaml); - Run flake8 checks (flake8) (local) For further details about tests please refer to: https://github.com/pre-commit/pre-commit-hooks Change-Id: Id03c1ea4752db3236c36521ca9c67125d5ba2526 Co-authored-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Fix pygments stylemelissaml2020-06-041-3/+1
| | | | | | | | New theme of docs respects pygments_style. more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I572495d50e0edc8bdfe22594dcde30a61b0750b8
* Merge "Add release notes links to doc index"Zuul2020-05-261-0/+6
|\
| * Add release notes links to doc indexHervé Beraud2020-04-161-0/+6
| | | | | | | | Change-Id: I33fc3e2579887e051ed5f47ebf96dcefc2bd8b49
* | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-182-7/+6
|/ | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Depends-On: https://review.opendev.org/728938 Change-Id: I072cf215486d672eacd3a57483cb2b311483c844
* [ussuri][goal] Drop python 2.7 support and testing7.0.0Hervé Beraud2020-02-031-2/+1
| | | | | | | | | | | | | | OpenStack is dropping the py2.7 support in Ussuri cycle. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: I02e2d11d38d2aa4182e8d466519b99f05943701f
* Bump the openstackdocstheme extension to 1.20melissaml2019-11-131-1/+1
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I2c3a36fbc020d41c5eaa09008a0586142a63d6ba
* tox: Keeping going with docscaoyuan2019-10-241-2/+2
| | | | | | | | | | | | Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Change-Id: Idaca0bc97e33e0a080de612420177b5e102c628c
* docs: Use sphinxcontrib.apidoc for building API docs5.0.0Stephen Finucane2019-05-213-45/+11
| | | | | | | | Gets us away from the old pbr functionality. Some cleanup of tox.ini is included along the way. Change-Id: Ia228f8ee49f31f88fa2a66f2aad3a3921c41a785
* Cap Bandit below 1.6.0 and update Sphinx requirementBen Nemec2019-05-131-1/+2
| | | | | | | | | | | | Bandit 1.6.0 accidentally changed how the exclusion list option is handled and breaks our use of it. Cap to the previous version until Bandit has fixed the problem. Sphinx 2.0 no longer works on python 2.7, so we need to start capping it there as well. Change-Id: If86c82e0f4a519baca664af79352846c4af9a01c Reference: https://github.com/PyCQA/bandit/pull/489
* List PyMySQL first in installation docsBen Nemec2018-04-241-2/+2
| | | | | | | | | | It's by far the most tested driver with oslo.db so it makes sense to have it first in the list of driver options. Mostly this is just to have a change to merge so the reno jobs get run again though. Change-Id: I5a9a05b6c3e3008cb1dfefc2df397003c2cbc7fd
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: Ia4e66a804bea3eee74fedc3c5a7f610cb05d9c8c
* Updated from global requirementsOpenStack Proposal Bot2018-01-241-1/+1
| | | | Change-Id: I383270a678de0e1fd1c1d563d5d72e13b14eb9ec
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | Change-Id: I52293d97aace6ac2e249417d09c01a841014f924
* Updated from global requirementsOpenStack Proposal Bot2018-01-161-1/+1
| | | | Change-Id: Id81f2a3321d563d35614fa0476a0743a982b88fc
* Use the new PTI for document buildChangBo Guo(gcb)2017-12-191-0/+8
| | | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more detials information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Iba311cc69ec5272d8beb433e3589c53f371d5d0a
* Updated from global requirementsOpenStack Proposal Bot2017-12-041-0/+3
| | | | Change-Id: Ib05517c968e4d4bc5a55cec3cbe4a619a1ab9c11
* Add requirements.txt for docs buildsSean McGinnis2017-12-041-0/+2
| | | | | | | | | | | Docs requirement some packages to be installed that are not currently captured in the requirements.txt file. This causes job failures in the post release jobs for oslo.db. Adding doc/requirements.txt to list the two packages needed for docs builds. Change-Id: Ic957202c00a2047e35bac361111976141aa60f6f
* Drop MySQL-python dependency from oslo.dbDirk Mueller2017-10-171-14/+0
| | | | | | | | | In order to fade out MySQL-python from OpenStack we need to stop testing it. Add release notes entry and adjust documentation references accordingly. Depends-On: Ie1f07062ed18350bcbb9e7b5e33c7ab2390be9ab Change-Id: Ie17f4543fa3d72b507d88d2c4023a9a5a430419e
* 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
|\ \ \ | |/ / |/| |
View Lorry Controller Status