Skip to content

Add a workflow that auto-generate the luxtronik field definition documentation#259

Merged
kbabioch merged 11 commits intoBouni:mainfrom
Guzz-T:issue/189/gen-docs
Mar 14, 2026
Merged

Add a workflow that auto-generate the luxtronik field definition documentation#259
kbabioch merged 11 commits intoBouni:mainfrom
Guzz-T:issue/189/gen-docs

Conversation

@Guzz-T
Copy link
Contributor

@Guzz-T Guzz-T commented Mar 11, 2026

Here I have taken up Bouni's Branch and put it into a more streamlined table format.

Replaces #192 and #224
Solves #189

@github-actions
Copy link

github-actions bot commented Mar 11, 2026

Coverage

Coverage Report
FileStmtsMissCoverMissing
luxtronik
   __main__.py25250%3–66
   datatypes.py450199%147
   discover.py58198%63
luxtronik/cfi
   interface.py172398%167–168, 253
luxtronik/definitions
   __init__.py207199%218
luxtronik/scripts
   __init__.py35586%7–16, 51
   discover_shi.py60600%8–98
   dump_cfi.py14657%18–25, 29
   dump_shi.py15660%21–28, 32
   performance_shi.py63630%7–89
   update_screen.py1058222%6, 20–41, 46–48, 51–61, 64, 70–75, 78, 81–85, 88–92, 95–97, 100–103, 106–111, 115–116, 119–126, 129–136
   watch_cfi.py321650%36–47, 50–56, 60
   watch_shi.py331652%38–49, 52–58, 62
luxtronik/shi
   interface.py320199%438
TOTAL240928688% 

Tests Skipped Failures Errors Time
378 0 💤 0 ❌ 0 🔥 18.158s ⏱️

@kbabioch
Copy link
Collaborator

Is there any way the result could be reviewed prior to merging it? So we can have a look at what it will look like?

@Guzz-T
Copy link
Contributor Author

Guzz-T commented Mar 12, 2026

The finished file has been checked in under docs/index.html. You could either check out the branch and view it locally, or temporarily switch the GitHub Pages configuration to that branch.

@Guzz-T
Copy link
Contributor Author

Guzz-T commented Mar 13, 2026

I've thought of a few more improvements. I'll incorporate them later.

@kbabioch kbabioch changed the title Add a workflow that auto-generate the luxtronik field definition documentation WIP: Add a workflow that auto-generate the luxtronik field definition documentation Mar 13, 2026
@kbabioch
Copy link
Collaborator

Added a WIP prefix. Feel free to remove it once you feel you're done.

@Guzz-T Guzz-T force-pushed the issue/189/gen-docs branch from ae59053 to 56c8603 Compare March 13, 2026 21:23
@Guzz-T
Copy link
Contributor Author

Guzz-T commented Mar 13, 2026

Well, I'm happy with it for now.

A preview can now also be found under https://guzz-t.github.io/python-luxtronik/.

@Guzz-T Guzz-T changed the title WIP: Add a workflow that auto-generate the luxtronik field definition documentation Add a workflow that auto-generate the luxtronik field definition documentation Mar 13, 2026
@kbabioch kbabioch merged commit 2f2ddfc into Bouni:main Mar 14, 2026
4 checks passed
@Guzz-T Guzz-T deleted the issue/189/gen-docs branch March 15, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants