Stephen Finucane 45e5452482 doc: Avoid duplicate entry warning

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>

2021-09-21 15:32:39 +01:00

764 B

Raw Blame History

API

Machines

automaton.machines.State

automaton.machines.FiniteMachine

automaton.machines.HierarchicalFiniteMachine

Runners

automaton.runners.Runner

automaton.runners.FiniteRunner

automaton.runners.HierarchicalRunner

Converters

automaton.converters.pydot

Exceptions

automaton.exceptions

Hierarchy