You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have a class that uses a namedtuple as a class variable:
class GreatClass(BaseClass):
CoolVar = namedtuple("CoolVar", ["x", "y"])
...
Prior to version 3.4.0 this class rendered fine with a correct inheritance diagram. Since the change from #485 in v3.4.0 building the docs produces the following warning:
/repo/docs/autoapi/module/index.rst:XX: WARNING: module.GreatClass.CoolVar specified for inheritance diagram is not a class or module [docutils]
which is true. I think the issue is that since #485namedtuples are reported as classes.
FWIW, the rendered docs still look correct, but the warning is breaking our build pipelines. Any advice would be greatly appreciated.
The text was updated successfully, but these errors were encountered:
Another issue that arises from defaulting to reporting namedtuples as class occurs when a namedtuple shares a name with a class in the same module (admittedly bad practice, but not disallowed by python). E.g.,
CoolThingTuple = namedtuple("CoolThing", ["foo", "bar"])
class CoolThing:
...
in this case building the docs produces the following warning:
/repo/docs/autoapi/module/index.rst:XX: WARNING: duplicate object description of module.CoolThing, other instance in autoapi/module/index, use :no-index: for one of them
Perhaps an configuration option to not report namedtuples as classes is the right direction to move here?
We have a class that uses a
namedtuple
as a class variable:Prior to version 3.4.0 this class rendered fine with a correct inheritance diagram. Since the change from #485 in v3.4.0 building the docs produces the following warning:
which is true. I think the issue is that since #485
namedtuples
are reported as classes.FWIW, the rendered docs still look correct, but the warning is breaking our build pipelines. Any advice would be greatly appreciated.
The text was updated successfully, but these errors were encountered: