First attempt to auto generate docs

[Bouni]

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

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
luxtronik
__init__.py	184	11	94%	42–43, 46–51, 257–258, 263
__main__.py	21	21	0%	3–49
datatypes.py	325	1	99%	114
discover.py	58	1	98%	62
luxtronik/scripts
dump_changes.py	43	43	0%	7–85
dump_luxtronik.py	26	26	0%	6–52
TOTAL	1811	103	94%

Tests	Skipped	Failures	Errors	Time
299	0 💤	0 ❌	0 🔥	5.878s ⏱️

[Bouni]

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]

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

[kbabioch]

What's the current status here? Are you going forward with this @Bouni? There are some minor warnings that might need to be fixed first.

[Bouni]

I have not looked into thsi for a while, but maybe the pre christmas days will give me enough spare time to get this up and running. I'll look into it

[Bouni]

@kbabioch I guess its ready for merging, take a look at https://bouni.github.io/python-luxtronik/

Can be improved in the future for sure but a good starting point in my opinion

[kbabioch]

@kbabioch I guess its ready for merging, take a look at https://bouni.github.io/python-luxtronik/

Can be improved in the future for sure but a good starting point in my opinion

Definitely a good starting point. Only one (hopefully) minor detail: The background color of Group "parameters" makes it hard to read:

The generated HTML looks like this:

<div class="is-size-5 mb-2">Group</div>
                        <span
                          class="tag is-medium"
                          style="background-color: oklch(37.2% 0.044 257.287)"
                          ><strong>parameters</strong></span
                        >

Maybe this can be changed easily?

[Bouni]

I've not checked with a light setting. I always use dark. I'll fix that soon!