Commit Graph
11 Commits
Author SHA1 Message Date
Nicolai Buchwitz c338069833 docs: enforce 100 character line width in docstrings
Reformatted docstrings across device.py, helper.py, and io.py to honor
the 100 character line width limit, improving readability and
consistency with project formatting standards.
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz e8af56ff70 ci: add Read the Docs configuration 2026-02-12 14:00:23 +01:00
Nicolai Buchwitz 7136a2b23a docs: use inline attribute docstrings for Sphinx compatibility
Added inline docstring documentation for Device class attributes:
- bmk, catalognr, comment, extend, guid, id, inpvariant, outvariant, type

Added inline docstrings for LED and IO attributes in device classes:
- Core: a1green, a1red, a2green, a2red, wd
- Connect: a3green, a3red, x2in, x2out
- ModularBaseConnect_4_5: a1-a5 red/green/blue
- Connect4: x2in, x2out
- Compact: a1green, a1red, a2green, a2red, wd
- Flat: a1-a5 green/red, switch, relais, wd

Translated remaining German text:
- 'Statusbit for piControl-Treiber laeuft' -> 'Status bit indicating piControl driver is running'
- 'Treiber laeuft' -> 'driver is running'
- 'Inputs to Bus schreiben' -> 'Write inputs to bus'
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz d4817adff1 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.
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz 4892adaeff docs: improve watchdog toggle terminology and formatting
Changed 'Autowatchdog' to 'automatic watchdog toggle' for clarity.
Fixed inconsistent indentation in _set_wdtoggle docstring.
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz e7d5bd9fdf docs: fix last German text in io.py docstring
Changed 'wenn Vorzeichenbehaftet' to 'if signed'
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz 3c56eed978 docs: translate German text in docstrings to English
Replaced German terms with English equivalents:
- Zustand → state
- vom → of the
- Ausgang → output
- Sekunden → seconds
- toggeln → toggle
- from → off
- gruen → green
- rot/root → red
- blau → blue
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz bf631ea176 docs: add missing docstrings to classes and methods
Added docstrings to:
- Error classes (RevPiModIOError, DeviceNotFoundError)
- ProductType constants class
- GatewayMixin class for piGate module detection
- IO __call__ methods (IOBase, IntIO, StructIO)
- MemIO.get_variantvalue method
- RevPiModIO context manager methods (__enter__, __exit__)
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz 2eac69b7bd docs: add comprehensive documentation structure and API reference
Created topic-based documentation:
- basics.rst: core concepts and fundamental usage
- cyclic_programming.rst: PLC-style programming with Cycletools
- event_programming.rst: event-driven patterns and callbacks
- advanced.rst: gateway IOs, replace_io_file, watchdog management
- installation.rst and quickstart.rst: getting started guides

Added complete API reference in docs/api/:
- All device classes including ModularBaseConnect_4_5 and GatewayMixin
- I/O, helper, and main class documentation

Enhanced Sphinx configuration with RTD theme and improved autodoc settings.
Removed auto-generated modules.rst and revpimodio2.rst.
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz b35edac694 fix: correct typos and complete German translations
- Fix remaining untranslated German text in param descriptions
- Fix typo: 'ist' -> 'is' in error messages
- Fix typo: 'fist' -> 'first' in comment
- Fix typo: 'configuraiton' -> 'configuration'
- Fix typo: 'thrading' -> 'threading' in docstring
- Translate remaining German TODO comment

Signed-off-by: Nicolai Buchwitz <n.buchwitz@kunbus.com>
2026-02-12 14:00:23 +01:00
Nicolai Buchwitz c26841cf94 docs: translate German comments and docstrings to English
Translate all inline comments, docstrings, and documentation from German to English across the codebase to improve accessibility for international developers.

Fixes #27

Signed-off-by: Nicolai Buchwitz <n.buchwitz@kunbus.com>
2026-02-12 14:00:23 +01:00