64c51a554c
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
52 lines
750 B
ReStructuredText
52 lines
750 B
ReStructuredText
===
|
|
API
|
|
===
|
|
|
|
--------
|
|
Machines
|
|
--------
|
|
|
|
.. autoclass:: automaton.machines.State
|
|
:members:
|
|
|
|
.. autoclass:: automaton.machines.FiniteMachine
|
|
:members:
|
|
:special-members: __iter__, __contains__
|
|
|
|
.. autoclass:: automaton.machines.HierarchicalFiniteMachine
|
|
:members:
|
|
|
|
-------
|
|
Runners
|
|
-------
|
|
|
|
.. autoclass:: automaton.runners.Runner
|
|
:members:
|
|
|
|
.. autoclass:: automaton.runners.FiniteRunner
|
|
:members:
|
|
|
|
.. autoclass:: automaton.runners.HierarchicalRunner
|
|
:members:
|
|
|
|
----------
|
|
Converters
|
|
----------
|
|
|
|
.. automodule:: automaton.converters.pydot
|
|
:members:
|
|
|
|
----------
|
|
Exceptions
|
|
----------
|
|
|
|
.. automodule:: automaton.exceptions
|
|
:members:
|
|
|
|
Hierarchy
|
|
---------
|
|
|
|
.. inheritance-diagram::
|
|
automaton.exceptions
|
|
:parts: 1
|