Add documentation for modules and runtime instructions
- Created detailed documentation for the device_manager, model, model_extra, osc, overlay, overlay_image, transcription, translation, transliteration, utils, watchdog, and websocket modules. - Added a comprehensive run events payloads document outlining the payloads sent during various run events in the controller. - Included runtime instructions and dependencies for setting up the project in a Windows environment. - Introduced a mypy configuration file to manage type checking and ignore errors in specific modules temporarily.
This commit is contained in:
32
src-python/mypy.ini
Normal file
32
src-python/mypy.ini
Normal file
@@ -0,0 +1,32 @@
|
||||
[mypy]
|
||||
# Temporarily ignore missing type stubs for third-party libraries to focus on
|
||||
# type errors inside the project. We'll tighten this later.
|
||||
ignore_missing_imports = True
|
||||
python_version = 3.11
|
||||
show_error_codes = True
|
||||
|
||||
# Per-module ignores can be added later for specific noisy modules.
|
||||
|
||||
[mypy-tests.*]
|
||||
ignore_errors = True
|
||||
|
||||
# Temporarily ignore entire implementation areas that produce many non-actionable
|
||||
# mypy errors (third-party untyped libs or large unannotated modules). We'll
|
||||
# progressively remove these ignores as we annotate the codebase.
|
||||
[mypy-models.transliteration.*]
|
||||
ignore_errors = True
|
||||
|
||||
[mypy-models.overlay.*]
|
||||
ignore_errors = True
|
||||
|
||||
[mypy-models.osc.*]
|
||||
ignore_errors = True
|
||||
|
||||
[mypy-models.transcription.*]
|
||||
ignore_errors = True
|
||||
|
||||
[mypy-models.translation.*]
|
||||
ignore_errors = True
|
||||
|
||||
[mypy-device_manager]
|
||||
ignore_errors = True
|
||||
Reference in New Issue
Block a user