summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove unnecessary unicode prefixessongwenping2022-04-221-4/+4
| | | | Change-Id: Iaae10962581b84b4ae2af1a064dd27d78c05dd4d
* Adding pre-commitHervé Beraud2020-09-091-3/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Introduced changes: - pre-commit config and rules - Add pre-commit to pep8 gate, Flake8 is covered in the pre-commithooks. - 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: Iba1e2ce707051ea393ac559fc51b1f07da1f6ee8 Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Fix pygments stylemelissaml2020-06-041-1/+1
| | | | | | | | New theme of docs respects pygments_style. more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I535b0627c37db7eb70c699642da0ffae36590329
* Merge "Add release notes links to doc index"Zuul2020-05-261-1/+12
|\
| * Add release notes links to doc indexHervé Beraud2020-04-161-1/+12
| | | | | | | | Change-Id: I4ae1aaea038fc8c5b05d455f44899c5b5b7f36f7
* | Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-182-6/+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 before the next release removes them. A couple of variables are also not needed anymore, remove them. Depends-On: https://review.opendev.org/728938 Change-Id: I3a57dfef23cee9dc4430f46063e89ffb54d0396c
* [ussuri][goal] Drop python 2.7 support and testing4.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: If437786eb8dbba9386dd473b45dab0933812c649
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-11-122-3/+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: Id5c6afef01c6f38cb72c3a6526352db40dcb3a87
* 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: I7d39be84c5c8bd730119220720d2d33cb9e4ef62
* Cap Bandit below 1.6.0 and update Sphinx requirementBen Nemec2019-05-151-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: I719a8cff50dcc0dea62db14edf7b9ab35b72facd Reference: https://github.com/PyCQA/bandit/pull/489
* Capitalize OsloBen Nemec2018-04-241-2/+2
| | | | | | | | | It's a proper name. Mostly this is just to trigger the release notes jobs again after they failed on release. Change-Id: I5ea88dfbad5b9d60d9b404cef4a586e92fb5a957
* Fix project name in user docsBen Nemec2018-03-291-3/+3
| | | | Change-Id: I6d000cd4bfa776011638d96891f8966cc804f422
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: I68a6de52dc412e026f8611052208afdc293f4069
* Updated from global requirementsOpenStack Proposal Bot2018-01-241-1/+1
| | | | Change-Id: Icf016d2a22157bcf84db1b71733904bdded49aa5
* Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
| | | | Change-Id: I969d8e0335a7d119f702b0cab30cbf61f6255905
* Updated from global requirementsOpenStack Proposal Bot2018-01-041-0/+3
| | | | Change-Id: Ia615971a83f613b396299ac015dbb2a4e02848b6
* Follow the new PTI for document buildChangBo Guo(gcb)2017-12-201-0/+5
| | | | | | | | | | | | 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: I3d86f1897dc900ba815c0c3975e95e27bb29b532
* rearrange existing documentation to fit the new standard layout3.27.0Akihiro Motoki2017-07-0126-50/+49
| | | | Change-Id: I0727caae202b385d740b006fd957b990e308c6d7
* switch from oslosphinx to openstackdocsthemeAkihiro Motoki2017-07-011-3/+10
| | | | Change-Id: Ief1b96ec6d08552f285540a68994c70cc9af3098
* Use Sphinx 1.5 warning-is-error3.24.0Stephen Finucane2017-03-161-2/+0
| | | | | | | | | | | | | | | | 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
* Add missing documentation for secretutilsEric Brown2017-02-231-1/+1
| | | | | | | | | | | | The current doc page for secretutils is blank [1], most likely because of the way constant_time_compare is in the exception block. This patch manually tells sphinx to doc the constant_time_compare function. Also adds the oslo.utils version when the module was added. [1]: https://docs.openstack.org/developer/oslo.utils/api/secretutils.html Change-Id: Ic1fb15176c93f126826f568149cabf4b8e5450d8
* Create dictutils and add 'flatten_dict_to_keypairs'Hanxi Liu2016-11-012-0/+7
| | | | | | | | | | | This function has been shared at least kwapi and all Telemetry projects including ceilometer, aodh, panko and gnocchi. As a generator, it produces sequence of keypairs for nested dictionaries. It seems to be good moving it to the common shared code. So add an initial dictutils and tests for it. Change-Id: Ibd7c2ce4ef9c2608910b26169a804eb463759c7f
* Trivial fixes to the usage docEric Brown2016-10-281-3/+3
| | | | | | | * Doc title containing too many = * A tab instead of spaces Change-Id: I87cc4cec257d937fcc87d98b76ef0446451fc822
* Add missing specs_matcher documentationChangBo Guo(gcb)2016-09-242-0/+7
| | | | | | Closes-Bug: #1616610 Change-Id: Id26af1ef6b19ace9d03611aba5389af644392b2c
* Merge "Create secretutils and include 'constant_time_compare' function"Jenkins2016-01-212-0/+7
|\
| * Create secretutils and include 'constant_time_compare' functionJoshua Harlow2016-01-192-0/+7
| | | | | | | | | | | | | | | | | | | | | | This code (or a version of it) is being shared by at least nova and keystonemiddleware and it seems like a good idea to move it to being common shared code (especially due to the importance of getting this code correct). This adds an initial secretutils and adds tests for it. Change-Id: Ia603202a065d5b345608e712f63f7af21fd74dea
* | Add missing doc index for imageutils and fnmatchChangBo Guo(gcb)2015-12-141-0/+2
| | | | | | | | | | | | | | | | We added these two modules recently, but didn't include them in doc index. This commit add them in doc index and add version information about when they were added. Change-Id: Ic3347f57a722187fc4bfe68fce6f08fba97af7fb
* | Use versionadded and versionchanged in docVictor Stinner2015-10-172-0/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document in which version new types and functions were added using ".. versionadded:: x.y". Document changes using ".. versionchanged:: x.y." For new modules, add the versionadded tag in the module top docstring, not on each type/function. Add fileutils to documentation. The doc part was forgotten during the graduation. Add docstrings to convert versions of versionutils. I used "git blame" + "git tag --contains=SHA1" to find these version, and then I checked manually each version. Change-Id: Ia2f00aa29eb36410a49fc1d350896a569a7737a1
* | Ensure stopwatch __enter__, __exit__ are in docsJoshua Harlow2015-10-011-0/+1
| | | | | | | | | | | | | | | | | | People typically want to know if this can be used as a context manager (it can); so make sure that the generated docs explicitly shows them (vs not showing them, which is the default). Change-Id: I97d512afc79581478a5b7e734108c38635b79f45
* | Add some timeutils stop watch examplesJoshua Harlow2015-09-302-0/+104
| | | | | | | | Change-Id: Id63243562bf92d370c3e3239ff4d64f53a0ace93
* | Move 'history' -> release notes sectionJoshua Harlow2015-09-251-1/+8
|/ | | | | | | | This seems to better match what the other oslo libraries are calling this section, so we might as well call it that to. Change-Id: Ib90d1e0bb2c90776c81a2b272f9aeb5c3565bfc6
* versionutils: add version convert helper methodsChangBo Guo(gcb)2015-07-102-0/+7
| | | | | | | | | | Nova[1] and Cinder[2] have same version convert methods. We can put them in versionutils and make them don't maintain their version. [1]https://github.com/openstack/nova/blob/master/nova/utils.py#L1044 [2]https://github.com/openstack/cinder/blob/master/cinder/utils.py#L789 Change-Id: I5a7e212bd0d661ce9ec89ae06a9f4c3bc7200d1e
* Add missing reflection + uuidutils docsJoshua Harlow2015-04-133-0/+14
| | | | | | | | | These do not seem to have been created and made appear, so make them appear and make sure the exposed public API(s) have docstrings so that they appear in the generated docs. Change-Id: Ie34e46647b0b20d936ddaa15dc824d0e2d2ca99d
* Add pypi download + version badgesJoshua Harlow2015-04-073-14/+22
| | | | | | | | Also makes the docs look more like the other oslo libraries so that the content is easily readable across projects. Change-Id: I85158a89f103cdef2afa268558592c46ce6c3411
* Add a eventlet utils helper moduleJoshua Harlow2015-02-101-0/+6
| | | | | | | | | | | | | | When greenthreads are being used (and/or eventlet is available and some modules have been monkey-patched) emit warnings to the users that certain modules should be monkey-patched and if they are not then spurious or unexpected lock-ups and/or hangs may result due to this type of mixed usage which doesn't typically end well. This commit adds that functionality to a new eventlet utils module that can be used by calling code when that code really knows it will not work without modules being patched or partially being patched. Change-Id: I9a856fc0a6502b438c8da9b2f589154a6fa89a9f
* Add TimeFixtureBrant Knudson2015-01-161-0/+6
| | | | | | | | There was no fixture for using the functions related to timeutils.set_time_override. A fixture is handy because clear_time_override must be done for cleanup. Change-Id: Ifef8d9f20fa9e5aa96ebf5040f290f65b503f0bd
* Move files out of the namespace packageDoug Hellmann2015-01-068-8/+8
| | | | | | | | | | Move the public API out of oslo.utils to oslo_utils. Retain the ability to import from the old namespace package for backwards compatibility for this release cycle. bp/drop-namespace-packages Change-Id: Ic6dd62097399bf75e3d11b4d8a6400971069c415
* Add history/changelog to docsDavanum Srinivas2014-10-042-0/+2
| | | | Change-Id: Iec3a5cfd6245835c39e7dbe0354abb3353e42d5f
* Add API docs and clean up other docsDoug Hellmann2014-07-2312-7/+66
| | | | | | | Add auto-generated documentation for the public modules in the library and clean up a bit of the docstrings used. Change-Id: Id5efa5c413b82e13f1a7ac78c92e39c193f12214
* Cleaning up index.rst fileChristian Berendt2014-07-211-6/+1
| | | | | | Removed notes about the generation of the file. Change-Id: I06355eb96cbd0fb564b7e7dbe3c10adecad74a1d
* exported from oslo-incubator by graduate.shDavanum Srinivas2014-06-186-0/+120
View Lorry Controller Status