Moved the part of the discussion about Doxygen documentation from #452 to its own issue here:

Can I suggest all (zigpy) developers start using Doxygen formatted inline code documentation in the source code files?

That way the bulk of any Developers documentation does not have to be maintained separately (which then would normally quickly be outdated) and can instead be generated live at any time from the latest code three using documentation generator tools.

https://en.wikipedia.org/wiki/Doxygen

You would really only have to agree to follow a standard for inline code documentation., which should not be too hard as Doxygen is the de facto standard and do support Python. Doxygen, is a documentation system that supports most programming languages today. It can generate html docs documenting a projects source code, by either extracting special tags from the source code (put there by people wanting to make use of doxygen), or doxygen will otherwise attempt to build the documentation from the existing source code.

https://www.doxygen.nl/index.html

CodeDocs will then generate and publish documentation from Doxygen for you, (free to setup with public GitHub repositories).

https://codedocs.xyz/

For example, you can check out the Kodi code documentation generated on codedocs.xyz

https://codedocs.xyz/AlwinEsch/kodi/

There are of course many different standards for inline code documentation and also many documentation generation tools, ex:

https://wiki.python.org/moin/DocumentationTools