I found myself looking into the docs very often, so I took the liberty and generated an mkdocs version of the AppDaemon API documentation – with search! It’s much easier for me.
I hope it’s of use to someone: https://ryqiem.github.io/AppDaemon-API/
I found myself looking into the docs very often, so I took the liberty and generated an mkdocs version of the AppDaemon API documentation – with search! It’s much easier for me.
I hope it’s of use to someone: https://ryqiem.github.io/AppDaemon-API/
What a great idea! It would be great if you could do one for HA Dashboard too!
Tagging in @aimc so he can see this.
I have to admit that my first thoughts were that ^F works very well for search, and why does anyone need any different.
However I do see that these search results are much more useful.
My one concern is that generating the pages has to be automatic and part of the build/release process. Having out of date/incorrect documentation is worse than having none at all.
I agree - I really like the format, and when I have a moment I will see if there is an easy way to generate it and keep it up to date somewhere viewable.
Let me know if I can be of some help in this Andrew; I think accessible docs are important and worth putting time into. If you can off load some of that to me, let me know.
Cool - I think think this can be automated and perhaps made part of our secret project which we should probably revisit
Understood. Seems like a good idea to me too.
Now I need to go learn about mkdocs.