openstack/automaton
Code Issues Proposed changes

doc: Avoid duplicate entry warning

Browse Source 
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>
This commit is contained in:
Stephen Finucane 2021-09-21 15:32:39 +01:00
parent 0461d8e766
commit 45e5452482
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/reference/index.rst
View File

@ -14,6 +14,7 @@ Machines
:special-members: __iter__, __contains__
.. autoclass:: automaton.machines.HierarchicalFiniteMachine
:noindex:
:members:
-------