45e5452482
Both the 'FiniteMachine' and 'HierarchicalFiniteMachine' in 'automaton.machines' define an 'Effect' attribute. It seems recent versions of autodoc can't handle this since we're seeing the following warning: automaton/machines.py:docstring of automaton.machines.Effect:1:duplicate object description of automaton.machines.Effect, other instance in reference/index, use :noindex: for one of them Do as it says and configure 'noindex' for the latter. This means we lose the ability to link to other members of this class but that's a necessary compromise since there's no way to exclude an individual member. Change-Id: Ic9e50f6b56a278032463357552960e40c2ddf6a7 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
53 lines
764 B
ReStructuredText
53 lines
764 B
ReStructuredText
===
|
|
API
|
|
===
|
|
|
|
--------
|
|
Machines
|
|
--------
|
|
|
|
.. autoclass:: automaton.machines.State
|
|
:members:
|
|
|
|
.. autoclass:: automaton.machines.FiniteMachine
|
|
:members:
|
|
:special-members: __iter__, __contains__
|
|
|
|
.. autoclass:: automaton.machines.HierarchicalFiniteMachine
|
|
:noindex:
|
|
: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
|