Commit Graph

9 Commits

Author SHA1 Message Date
3294c5e980 docs: Update documentation for improved clarity and consistency
Revised various sections across multiple documentation files to reflect
updated methods (`run_plc` replacing manual setup with `cycleloop`) and
adjust for new default parameters (e.g., `autorefresh`). Enhanced
descriptions for timers, Cycletools usage, and new method explanations.
Removed outdated or redundant examples and updated system requirements.

Signed-off-by: Sven Sager <akira@narux.de>
2026-02-17 12:05:58 +01:00
Nicolai Buchwitz
bae85e1b09 docs: add docs extra dependencies and missing _static directory
The Read the Docs build fails because the "docs" extra is referenced in
.readthedocs.yaml but not defined in setup.py, so sphinx_rtd_theme is
never installed.

Signed-off-by: Nicolai Buchwitz <n.buchwitz@kunbus.com>
2026-02-12 15:05: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
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
3771a7847e Replaces Master-Slave with Client-Server
Expunging all occurrences of inappropriate language of the query and
response paradigm of PLC communications. We are familiar with the Modbus
terminology and fully support this change.
https://www.modbus.org/docs/Client-ServerPR-07-2020-final.docx.pdf
2023-02-07 09:38:11 +01:00
7d482d498c Change license from LGPLv3 to LGPLv2 after approval of all contributors
https://github.com/mindstorm38 approved license change
https://github.com/nbuchwitz approved license change
2023-02-03 12:10:43 +01:00
8ddb323f24 Update documentation 2023-01-31 20:05:04 +01:00
10af9a01d5 Docstrings optimieren 1 2019-10-20 22:36:09 +02:00
11ceb6f4a2 Added Cycletools to __init__ and Switched VCS and IDE
Switched from Mercurial to GIT
Switched from eric6 to pyCharm
2019-10-20 14:30:36 +02:00