openstack/automaton
Code Issues Proposed changes
be2885f544
automaton/doc/source/api.rst

52 lines
750 B
ReStructuredText
Raw Normal View History

Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
===
API
===
--------
Machines
--------
Provide a finite machine build() method This method can be quite useful to simplify building a state-machine in a automated manner. Change-Id: I1428f95bad1637c565745673f5ce018d9439f442
2015-07-17 16:27:47 -07:00
.. autoclass:: automaton.machines.State
:members:
Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
.. autoclass:: automaton.machines.FiniteMachine
:members:
Ensure machine special method(s) include in generated docs Without explicitly mentioning that it should have its docs generated sphinx won't generate docs for it, so ensure that we list __iter__ and __contains__ so that it does get generated docs. Also fixes 'default_start_state' docs which were not showing up since they were on the setter method vs the getter method. Change-Id: I83d02a3604678d16b16f6da5384ff10543af850f
2016-01-06 21:03:35 -08:00
:special-members: __iter__, __contains__
Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
.. autoclass:: automaton.machines.HierarchicalFiniteMachine
:members:
-------
Runners
-------
Add runners to features.rst & add a runner base & update docstrings Change-Id: I18d7a656f537c3bf28257d24adc4a900e77906f3
2015-06-27 11:08:23 -07:00
.. autoclass:: automaton.runners.Runner
:members:
Split the state machine runners off into own file When using a state machine it is not always desired to use the runner concept, so to ensure both concepts are modular split runners off into there own module. Change-Id: Iac8ce50b0a17468190f3f737663b5b094c324a55
2015-06-05 17:06:25 -07:00
.. autoclass:: automaton.runners.FiniteRunner
Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
:members:
Split the state machine runners off into own file When using a state machine it is not always desired to use the runner concept, so to ensure both concepts are modular split runners off into there own module. Change-Id: Iac8ce50b0a17468190f3f737663b5b094c324a55
2015-06-05 17:06:25 -07:00
.. autoclass:: automaton.runners.HierarchicalRunner
Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
:members:
Add optional machine conversion into a pydot graph Both ironic and taskflow share this same code to convert their state machines into a pydot graph which then gets converted into SVG to form: - http://docs.openstack.org/developer/taskflow/states.html - http://docs.openstack.org/developer/ironic/dev/states.html So instead of duplicating it, provide a useful helper function that both (and others) can share to produce a dot/graphviz pretty diagram from a state machine. Change-Id: I218740910163a1ca2587d706edc55852af1c0c74
2015-06-13 13:10:51 -07:00
----------
Converters
----------
.. automodule:: automaton.converters.pydot
:members:
Revamp repo to match openstack repos Get the repo in a working state so that it works with the new and improved openstack CI system. Change-Id: I80661c35fa7109a7ee9b1d00f89ca521a469eed0
2015-06-05 15:45:11 -07:00
----------
Exceptions
----------
.. automodule:: automaton.exceptions
:members:
Add base exception class for this library To make it easier for users of this library to differentiate general exceptions from automaton exceptions it is quite common to have a root exception class that libraries use (and derive there exceptions from); this adds that. Change-Id: I140cb188f58849ac5caea97ed5a422375b549f6f
2015-06-23 12:32:36 -07:00
Hierarchy
---------
.. inheritance-diagram::
automaton.exceptions
:parts: 1
Copy Permalink