summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove unnecessary unicode prefixes4.5.1songwenping2022-04-191-1/+1
| | | | Change-Id: I56651c1b83baaf443551686d7e8545eba2a0c7a1
* Adding pre-commitHervé Beraud2020-09-031-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: I6ae02d4e52fd812360414e7b8c1c9c4f17230812 Signed-off-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: I8847feba7669feed9edf9d7f7ba48af26760c298
* 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. A couple of variables are also not needed anymore, remove them. Depends-On: https://review.opendev.org/728938 Change-Id: Ifd0f8e57c0052e5102aa914c8326159a72dad43c
* Add release notes links to doc indexHervé Beraud2020-04-161-0/+8
| | | | Change-Id: I894f621a66a745570a57a149f9033d0681f52d8c
* Drop python 2.7 support and testing4.0.0Stephen Finucane2020-01-301-2/+1
| | | | | | | | Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: I94e709093e01825069b44b6c485e49a81f8f14c1 Sem-Ver: api-break
* 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: Id12730272782a7cfda89cba79d40919e2a5ecd24
* Merge "Bump the openstackdocstheme extension to 1.20"Zuul2019-10-172-2/+1
|\
| * Bump the openstackdocstheme extension to 1.20pengyuesheng2019-10-122-2/+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: Ia04d1de7e10783350e3aa091eab64d1cbd7f070a
* | Document management and history of lock filesBen Nemec2019-10-152-0/+97
|/ | | | | | | | | | | | | | Something that comes up regularly on the mailing list is the topic of leftover lock files from interprocess locks. An Oslo developer then has to explain why they work the way they do, and this is a not-inconsiderable time suck because it is a complex topic. This change adds an administrator guide that explains what should and should not be done with lock files, and provides an FAQ section to (hopefully) pre-emptively answer many of the common questions people ask. Change-Id: I5442806ef2f107e3b7569a79bffdc344769545b0
* Blacklist sphinx 2.1.0 (autodoc bug)pengyuesheng2019-10-101-1/+1
| | | | | | See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details Change-Id: I9defdd3731950af42438ec96d0f1040fe1b5661d
* 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: Ib340f5822b124e78cd96ee12f9f033d5f313e238 Reference: https://github.com/PyCQA/bandit/pull/489
* Follow the new PTI for document buildZhongShengping2019-04-023-35/+21
| | | | | | | | | | | | | 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: I4b1b023ff2c40f5b31429584fc1a77c0315ed2d9 Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
* Add support for fair locksChris Friesen2018-11-021-0/+26
| | | | | | | | | | | | | | | This adds support for a "fair" variant of the lock. When there are multiple entities within a single process that are blocked waiting for the lock the fair lock will ensure that they acquire the lock in FIFO order. For now at least, when fair locks are in use we don't support the "semaphores" argument. If external locks are enabled, the inter-process ordering will be determined by the underlying OS lock ordering and process scheduling. Change-Id: I37577becff4978bf643c65fa9bc2d78d342ea35a
* switch from oslosphinx to openstackdocsthemeDoug Hellmann2017-07-111-2/+8
| | | | | Change-Id: Ieadf9b992b269d54dd9c79523d5879b6ad71ba7c Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* rearrange existing documentation to follow the new layout standardDoug Hellmann2017-07-1114-23/+21
| | | | | Change-Id: I79d7b97c7e9395f75fa158d870485853418a4db7 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Add doc/ to pep8 checkYuriy Taraday2016-05-121-1/+1
| | | | | | | We had unused imports there, this would prevent us from letting more of such errors in. Change-Id: Ie78c18dd3b9ab34370e47eba98b32740e0c83e1d
* Remove unused import statementChangBo Guo(gcb)2016-05-121-2/+1
| | | | | | | We don't use fnmatch and fileinput, so remove them. Change-Id: Ic49f3a03f4ccafcd02c549a6bdb0a3175f9e07e1
* Add a few usage examples for lockutilsJoshua Harlow2016-03-171-0/+51
| | | | | | | | There was a complaint that the usage examples in oslo.concurrency are lacking (which they are) so this addresses some of those concerns by adding a few usage examples (and descriptions). Change-Id: I0738b898f1235e83a600c7732d70058b3fd3860f
* 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: I4a486d0ca61f81413ea398d5955b4027d66ce360
* add auto-generated docs for config optionsJoshua Harlow2015-09-243-2/+11
| | | | | | | Add automatically generated documentation for the configuration options using oslo_config.sphinxext. Change-Id: If7eb94b268bb82e0fcfbac9dfd231ea25ff53b24
* Add pypi download + version badgesJoshua Harlow2015-04-072-9/+8
| | | | | | | | Also makes the docs look more like the other oslo libraries so that the content is easily readable across projects. Change-Id: I7b048bc4425197f87436281dd5e46619390c3f43
* add watchdog moduleSean Dague2015-01-092-0/+9
| | | | | | | | | | | | | | | This provides the watchdog.watch function which is a contextmanager that can be used before doing operations that have a high risk of deadlocking or aberrantly taking huge amounts of time to complete (which could be the root cause for other issues). Unit tests require the use of sleep to make the timers pop either before or after the event in question. There is 1 second buffer that's encoded into each scenario which should be sufficient for unit tests (even in busy systems). If that turns into an issue later, the buffer can be increased (I was only seeing real skew of 1-2 ms locally). Change-Id: I79e39f8a4aa702627ca39bea3e6fc672134b8a72
* Clean up API documentationDoug Hellmann2014-12-108-30/+68
| | | | | | | | | | | | Use explicit files instead of auto-generating them. Fail the build on a warning. Tweak titles and other headings. Add instructions for using lockutils-wrapper. Change-Id: Ie92ce14b33180d35d84bbd0998e61b659487481d
* Move out of the oslo namespace packageDoug Hellmann2014-11-141-2/+3
| | | | | | | | | | Move the public API out of oslo.concurrency to oslo_concurrency. Retain the ability to import from the old namespace package for backwards compatibility for this release cycle. bp/drop-namespace-packages Change-Id: I20d1647b1c3ef8cab3b69eccfe168eeb01703b72
* Only modify autoindex.rst if it existsDan Prince2014-10-291-8/+10
| | | | | | | This fixes doc build errors when using older Sphinx versions. Change-Id: I0ed9bed311d6309257c0a111671d0fea46f5da7c Closes-bug: #1387343
* Merge "Add history file to documentation"Jenkins2014-09-232-0/+2
|\
| * Add history file to documentationDoug Hellmann2014-09-042-0/+2
| | | | | | | | | | | | Show the ChangeLog in the history page of the documentation. Change-Id: I308b6eb1e729e78ae7c8c9e838d62587ac20cf66
* | Add code/api documentationDavanum Srinivas2014-09-042-0/+27
|/ | | | | | | | | | | Once we use the pbr based build to generate files, we prune the indexes to remove references to code we would like to hide like the common modules and private modules in conf.py. We reuse the same excluded_patterns variable that is already used in Sphinx and filter these modules from autoindex.rst Change-Id: I4baea1efa227ef14bc6706d59ff3dcad93c2eacc Closes-Bug: #1364140
* Fix docs generationYuriy Taraday2014-08-162-2/+6
| | | | | | Also add docs environment to tox.ini to simplify local docs generation Change-Id: Ie0444264e4e02d206ded2c7568d58a26cfec3ae2
* exported from oslo-incubator by graduate.shYuriy Taraday2014-08-076-0/+120
View Lorry Controller Status