From d4817adff1bf44b7469a166dd76be818df2a270b Mon Sep 17 00:00:00 2001 From: Nicolai Buchwitz Date: Tue, 3 Feb 2026 16:22:38 +0100 Subject: [PATCH] docs: enable inherited members display by default Added :inherited-members: to autodoc_default_options in conf.py so all classes automatically show inherited methods and attributes from their base classes. This makes Connect5 show members from GatewayMixin and ModularBaseConnect_4_5, for example. --- docs/api/device.rst | 9 +++++++++ docs/conf.py | 1 + 2 files changed, 10 insertions(+) diff --git a/docs/api/device.rst b/docs/api/device.rst index 8d6e846..ce42a48 100644 --- a/docs/api/device.rst +++ b/docs/api/device.rst @@ -70,6 +70,7 @@ ModularBaseConnect_4_5 :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Base class for Connect 4 and Connect 5 modules. @@ -81,6 +82,7 @@ Core :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Revolution Pi Core module. @@ -92,6 +94,7 @@ Connect :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Revolution Pi Connect module. @@ -103,6 +106,7 @@ Connect4 :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Revolution Pi Connect 4 module. @@ -114,6 +118,7 @@ Connect5 :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Revolution Pi Connect 5 module. @@ -125,6 +130,7 @@ DioModule :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Digital I/O module. @@ -136,6 +142,7 @@ RoModule :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Relay output module. @@ -147,6 +154,7 @@ Gateway :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Gateway module (ModbusTCP, Profinet, etc.). @@ -158,6 +166,7 @@ Virtual :members: :undoc-members: :show-inheritance: + :inherited-members: :special-members: __init__ Virtual device for custom applications. diff --git a/docs/conf.py b/docs/conf.py index 513a578..87460c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -34,6 +34,7 @@ autodoc_default_options = { 'member-order': 'bysource', 'special-members': '__init__', 'undoc-members': True, + 'inherited-members': True, 'exclude-members': '__weakref__' }