Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First attempt to auto generate docs #192

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

First attempt to auto generate docs #192

wants to merge 6 commits into from

Conversation

Bouni
Copy link
Owner

@Bouni Bouni commented Dec 12, 2024

This is an attempt to auto generate a docs page hosted on GH pages

Copy link

github-actions bot commented Dec 12, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
luxtronik
   __init__.py1841194%42–43, 46–51, 257–258, 263
   __main__.py21210%3–49
   datatypes.py276199%82
   discover.py403415%21–69
luxtronik/scripts
   dump_changes.py43430%7–85
   dump_luxtronik.py26260%6–52
TOTAL67613680% 

Tests Skipped Failures Errors Time
124 0 💤 0 ❌ 0 🔥 4.094s ⏱️

@Bouni
Copy link
Owner Author

Bouni commented Dec 12, 2024

I removed the pages branch protection by intent as well as the on: branch constraint in order to get a GH pages deüploy that can be live viewed.

https://bouni.github.io/python-luxtronik/

This is a first, very rough draft of what I imagine to be what users use to figure out which id to use in their HA config ....

@Bouni
Copy link
Owner Author

Bouni commented Dec 16, 2024

@Guzz-T Changed the sccript to use import rather than regex. Obviously much better now, thanks for the input 👍

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.

2 participants