revpi/revpimodio2
1
0
Fork 0
mirror of https://github.com/naruxde/revpimodio2.git synced 2026-03-31 15:08:09 +02:00
Code Issues Packages Releases Wiki Activity

docs: enable inherited members display by default

Browse Source 
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.
This commit is contained in:
Nicolai Buchwitz
2026-02-03 16:22:38 +01:00
committed by Sven Sager
parent 4892adaeff
commit d4817adff1
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/device.rst
View File

@@ -70,6 +70,7 @@ ModularBaseConnect_4_5
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Base class for Connect 4 and Connect 5 modules. Base class for Connect 4 and Connect 5 modules.
@@ -81,6 +82,7 @@ Core
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Revolution Pi Core module. Revolution Pi Core module.
@@ -92,6 +94,7 @@ Connect
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Revolution Pi Connect module. Revolution Pi Connect module.
@@ -103,6 +106,7 @@ Connect4
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Revolution Pi Connect 4 module. Revolution Pi Connect 4 module.
@@ -114,6 +118,7 @@ Connect5
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Revolution Pi Connect 5 module. Revolution Pi Connect 5 module.
@@ -125,6 +130,7 @@ DioModule
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Digital I/O module. Digital I/O module.
@@ -136,6 +142,7 @@ RoModule
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Relay output module. Relay output module.
@@ -147,6 +154,7 @@ Gateway
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Gateway module (ModbusTCP, Profinet, etc.). Gateway module (ModbusTCP, Profinet, etc.).
@@ -158,6 +166,7 @@ Virtual
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
:inherited-members:
:special-members: __init__ :special-members: __init__
Virtual device for custom applications. Virtual device for custom applications.

1
docs/conf.py
View File

@@ -34,6 +34,7 @@ autodoc_default_options = {
'member-order': 'bysource', 'member-order': 'bysource',
'special-members': '__init__', 'special-members': '__init__',
'undoc-members': True, 'undoc-members': True,
'inherited-members': True,
'exclude-members': '__weakref__' 'exclude-members': '__weakref__'
} }