summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
* Fix doc building with Sphinx 6.0Eric Harney2023-03-211-2/+2
| | | | | | Fix Sphinx 6.0 doc build error. Change-Id: I9a1571cf416d32d040d8ff05d1c8b1769d1d0558
* remove unicode prefix from codeniuke2022-08-241-2/+2
| | | | Change-Id: I59e8ae94eb83ae3a1ddcc99091e53686d2d55186
* Remove sixTakashi Kajinami2022-05-181-5/+0
| | | | | | | | This library no longer supports Python 2, thus usage of six can be removed. This also removes workaround about pickle library used in Python 2 only. Change-Id: I19d298cf0f402d65f0b142dea0bf35cf992332a9
* Updating for OFTC IRC network4.6.1Michael Johnson2021-06-071-1/+1
| | | | Change-Id: I47faea9b3c0324d3860a5209d521bc76de03bc47
* Adding pre-commitHervé Beraud2020-09-081-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: I3640bb690c552a428ae0e8250adffbc3a51a310e Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
* Switch to newer openstackdocstheme and reno versions4.2.0Andreas Jaeger2020-06-021-4/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 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. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Ieb7ce05f6611ad743336a35065402888176c7de3
* Add release notes links to doc indexHervé Beraud2020-04-161-0/+6
| | | | Change-Id: Ie42f30fa22c0d9864e355c4037520bcca3747a76
* update git.openstack.org to opendev3.7.0liuwei2019-05-222-28/+5
| | | | Change-Id: Ie9f1ca14eed287f3c25553d029d4a4b2ca5274d0
* Update doc/conf.py to avoid warnings with sphinx 1.83.3.13.3.0zhang.lei2018-09-191-1/+1
| | | | | | | | | The autodoc_default_flags option is now deprecated.[1] This warning can cause documentation build failed. use autodoc_default_options instead. [1]https://github.com/matplotlib/matplotlib/pull/11928 Change-Id: I6ba69ca7361fd0e42b322f1b92fe22b952a13321
* Fix a symbol errorjiansong2018-08-201-1/+1
| | | | | | | | There is a wrong use ' here, which causes the document to make errors when copying the code for experimentation. Change-Id: I3ae19f591ffd668bcd1563bd1e317b21b799dba6
* Update various links in docsVu Cong Tuan2018-07-172-8/+8
| | | | | | Avoid redirects, s/http/https/. Change-Id: Id03bd49f250b48109967a0e04b92b75925f08932
* replace http with httpszhangzs2018-06-132-3/+3
| | | | Change-Id: Ic01648cae18bf674cf5ee2753043dac7c5fc9ed0
* Fix doc buildBen Nemec2018-05-091-3/+3
| | | | | | | | | | | | | | | | | | | | Most notably, taskflow is hitting the sphinx issue https://github.com/sphinx-doc/sphinx/issues/2549 which causes a spurious warning that breaks the build with -W. There is a workaround posted in https://stackoverflow.com/questions/31784830/sphinx-ivar-tag-goes-looking-for-cross-references to move :ivar: docstrings to inline comments on the member variable itself. This is not ideal because it causes the docs to render differently from :ivar:, but until the sphinx bug is fixed it will allow us to keep documenting the problematic variables. There was also a problem with one of the doctests because the output had changed. That is now fixed. I also noticed a typo in one of the parameter descriptions so that is fixed too. Change-Id: Ib44621f6c3ba2c5476ec430218a0449f9f45d18f
* Trivial: Update pypi url to new urlmelissaml2018-04-211-1/+1
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: I0c8a226317fa62658555cb9a18028f1516aeccfe
* Update URLs in documents according to document migrationChangBo Guo(gcb)2017-07-133-3/+3
| | | | Change-Id: I9ca92fdcec388e02462332e04fe7c1bf8b5f64b8
* switch from oslosphinx to openstackdocsthemeDoug Hellmann2017-07-081-11/+9
| | | | | Change-Id: I7522d14d4e340f0882e41bed3528f90bbf74c2af Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* rearrange existing documentation into the new standard layoutDoug Hellmann2017-07-0835-132/+137
| | | | | Change-Id: Ic53baaa62771fda6de3b3dfe861909365103d1a9 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Fix html_last_updated_fmt for Python3Vu Cong Tuan2017-06-061-2/+1
| | | | | | | | | | | | | | | | | html_last_updated_fmt option is interpreted as a byte string in python3, causing Sphinx build to break. This patch makes it utf-8 string. Changing Popen to .check_output because of 3 reasons: 1. check_output() will raise CalledProcessError if the called process returns a non-zero return code. 2. For consistency with keystone [1] and cinder [2] 3. It makes the code look much better. [1] https://review.openstack.org/#/c/457142/ [2] https://review.openstack.org/#/c/433081 Change-Id: I6e9c2009f224abc282acbf957d7e999c7f87e9eb
* Use https instead of http for git.openstack.orggecong19732017-02-071-1/+1
| | | | | | TrivialFix Change-Id: I7c9f2dc507641a03717333a5e0c0479f96379326
* Rename engine analyzer to be named selectorJoshua Harlow2017-01-031-3/+3
| | | | | | | | | | | | | This moves out the engine next to run (or revert) selection process to a single class that just does this and moves out the common functions the analyzer class provided to the runtime object (which all components can access). This makes it easier to adjust the selection algorithm in different ways. Change-Id: I091c69297a7bff60729791d3ca6c3fae14d6eea5
* Replaces uuid.uuid4 with uuidutils.generate_uuid()2.8.0qinchunhua2016-11-221-3/+3
| | | | | Change-Id: I25e6e56a270d1d99ee2ddac52abfc9f5678f0a70 Closes-Bug: #1082248
* Merge "Fix a typo in documentation"Jenkins2016-10-111-1/+1
|\
| * Fix a typo in documentationLuong Anh Tuan2016-10-041-1/+1
| | | | | | | | | | | | remove redundant 'this' Change-Id: I93495166526ce695a41ee58dd00cc48a1858157f
* | Fix typo: remove redundant 'that'Luong Anh Tuan2016-10-031-1/+1
|/ | | | Change-Id: I2206b0b1747dfb3301eef5013749cfd20b5b32df
* Instead of a multiprocessing queue use sockets via asyncoreJoshua Harlow2016-05-241-0/+1
| | | | | | | | | | | | | | | | | | | | | | For a local process based executor usage currently to ensure that task emitted notifications are proxied we use the multi processing library and use its queue concept. This sadly creates a proxy process that gets associated, and this proxy process handles the queue and messages sent to and from it. Instead of doing this we can instead just create a temporary local socket using a random socket and have tasks (which are running in different processes) use that to communicate back any emitted notifications instead (and we can use the asyncore module to handle the emitted notifications since it handles the lower level socket reading, polling and dispatching). To ensure that the socket created is somewhat secure we use a similar process as the multi-processing library uses where we sign all messages with a hmac that uses a one time key that only the main process and the child process know about (and reject any messages that do not validate using this key). Change-Id: Iff9180054bf14495e5667af00ae2fafbdbc23791
* Fix documentation related to missing BaseTask classGreg Hill2016-05-114-13/+13
| | | | | | | The docs no longer matched reality. Change-Id: I9ee98e16fc03489569bbed8355416a73f7bc02ff Closes-Bug: 1579890
* Remove deprecated things for 2.0 releaseJoshua Harlow2016-05-102-6/+1
| | | | Change-Id: Id9adbc50bd51adc77ce88f698ad0ea2ee63fc5e2
* Merge "Spice up WBE banner and add simple worker __main__ entrypoint"Jenkins2016-04-281-0/+5
|\
| * Spice up WBE banner and add simple worker __main__ entrypointJoshua Harlow2016-02-081-0/+5
| | | | | | | | Change-Id: Ifdf275a623352aa3e42fbf0aa9a4394b64b54337
* | Don't set html_last_updated_fmt without gitThomas Bechtold2016-04-131-2/+3
| | | | | | | | | | | | | | | | | | | | | | Using a timestamp as value for "html_last_updated_fmt" isn't good for the reproducible builds initiative from different downstream distributions because the build result always differs due to the timestamp in the documentation. Also when not setting "html_last_updated_fmt", the value can be set via command line when running "sphinx-build -D". Change-Id: Ic8912e95e8e298fede1d94c20d3167d1f206df1e
* | Fallback if git is absentDavanum Srinivas2016-03-021-2/+6
| | | | | | | | | | | | | | | | When building packages if git is absent, then we should fall back to a safe default. Closes-Bug: #1552251 Change-Id: Ife309625a380cf7d5cc42581ed6d8f9f72b86cd9
* | Some WBE protocol/executor cleanupsJoshua Harlow2016-02-141-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Remove some of the usage of @property as none of these objects are publicly exposed (or have docstrings on them) to save some space/lines of code that aren't really adding any benefit. Use less **kwargs when we know exactly what the keyword arguments will or will not be. Being explicit makes it easier to understand these functions (vs not knowing what the arguments can or can't be). Removes base worker finder because right now we only have one implementation (at some point we will have two) but we can just wait to add a base class until then. Change-Id: I7107ff6b77a355b4c5d301948355fb6386605388
* | Fix for WBE sporadic timeout of tasksJoshua Harlow2016-02-051-5/+0
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | This fixes the sporadic of tasks that would happen under certain circumstances. What happened was that a new worker notification would be sent to a callback while at the same time a task submission would come in and there would be a small race period where the task would insert itself into the requests cache while the callback was processing. So to work around this the whole concept of a requests cache was revamped and now the WBE executor just maintains its own local dictionary of ongoing requests and accesses it safely. During the on_wait function that is periodically called by kombu the previous expiry of work happens but now any requests that are pending are matched to any new workers that may have appeared. This avoids the race (and ensures that even if a new worker is found but a submission is in progress that the duration until that submission happens will only be until the next on_wait call happens). Related-Bug: #1431097 Change-Id: I98b0caeedc77ab2f7214847763ae1eb0433d4a78
* Merge "Retrieve the store from flowdetails as well, if it exists"Jenkins2016-01-261-0/+60
|\
| * Retrieve the store from flowdetails as well, if it existsGreg Hill2016-01-251-0/+60
| | | | | | | | | | | | | | | | Gives users a more permanent way to provide an initial set of arguments to a flow. Change-Id: Ib9c3d60882548120d467a645bbac9be78408bac3 Implements: blueprint flow-details-keep-store
* | Merge "Use automaton's converters/pydot"Jenkins2016-01-252-4/+4
|\ \ | |/ |/|
| * Use automaton's converters/pydotJoshua Harlow2015-10-112-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | This uses the automaton library's converters/pydot to generate the state machine diagram. It also regenerates the diagrams using this new code base. Depends-On: I968a15ebce839761d0a935ba6b22de64b3b7783c Change-Id: Ie59e093196d06c634378e4f4099f681b3c425aac
* | Merge "Replace deprecated library function os.popen() with subprocess"Jenkins2016-01-151-2/+5
|\ \
| * | Replace deprecated library function os.popen() with subprocessting.wang2016-01-131-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | os.popen() is deprecated since python 2.6. Resolved with use of subprocess module. Change-Id: I41bc6c63b60a6f863a734b4c3264a706c3fddb60 Closes-Bug: #1529836
* | | Allow for alterations in decider 'area of influence'Joshua Harlow2016-01-092-0/+3
|/ / | | | | | | | | | | | | | | Christmas came early. Closes-Bug: #1479466 Change-Id: I931d826690c925f022dbfffe9afb7bf41345b1d0
* | fix doc change caused by the change of toozZhihai Song2015-12-141-1/+1
| | | | | | | | | | | | | | tooz is move to openstack project from the stackforge project. This commit fix the doc accordingly. Change-Id: Ib3abf3819e346daed4243395f1b31304f2327bb7
* | Add a executor backed conductor and have existing impl. use itJoshua Harlow2015-11-121-1/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds a executor backed job dispatching base class and has the existing blocking executor use it by running jobs and dispatching jobs into a sync executor. It also allows for dispatching jobs into a thread executor, or other executor via a new '_executor_factory' method that can generate executors (it can be overriden in the non-blocking executor to provide your own executors instances). This does alter the behavior in that now that jobs are dispatched into an executor we no longer can immediatly know if a job was dispatched and raised an exception or whether it will raise an exception in the future, so we now alter the 'local_dispatched' to just be a boolean that is used to determine if any dispatches happened (failure or not). Change-Id: I485770e8f4c85d3833892a453c9fb5168d8f0407
* | Register conductor information on jobboardtonytan4ever2015-10-191-0/+5
|/ | | | Change-Id: I3bf935280a6e8b265045b09fde43d0ec7dc56f07
* Fix bad sphinx module referenceJoshua Harlow2015-10-051-1/+1
| | | | | | Closes-Bug: #1503085 Change-Id: I7baa826a5db02d8f1e10639e0648676da4cfb4f8
* Merge "Rename 'history' -> 'Release notes'"Jenkins2015-09-251-2/+2
|\
| * Rename 'history' -> 'Release notes'Joshua Harlow2015-09-251-2/+2
| | | | | | | | | | | | | | | | 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: I67773ef2241dcf2f2a1cd65756ac0f8a8081c9cb
* | Merge "Explain that jobs arch. diagram is only for zookeeper"Jenkins2015-09-221-1/+6
|\ \ | |/ |/|
| * Explain that jobs arch. diagram is only for zookeeperJoshua Harlow2015-09-021-1/+6
| | | | | | | | Change-Id: I9081f373ca9f0a3bb803f3a798e09ab68ccd1b71
* | Merge "Extend and improve failure logging"Jenkins2015-09-141-0/+5
|\ \
| * | Extend and improve failure loggingJoshua Harlow2015-08-071-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | Add the ability to show the intention, result, and state of predecessors of the atom that has failed so that more contextual information can be shown in the logs that are written. Change-Id: Ic77c0d4e94a147e54da74976c1d148aef82eccb3
View Lorry Controller Status