Disclaimer…

The LCPF “API” isn’t a traditional API in the sense of most Python frameworks, where a developer is expected to have an awareness of the moduled (to be __import__ed), classes, functions, etc. the framework provides.

However, there obviously is a collection of LCPF modules, classes, etc. working “behind the curtain” to make the magic happen. It is not something most users of the LCPF will need to be aware of, and it’s more likely to confuse them if they try.

There is some documentation in that code, and we use sphinx/autodoc2 to pull it out. But adding documentation to the internal code has not yet been a high priority, so it’s far from complete. The integration of the generated HTML into the NextJS/Nextra based LCPF docs site also still has a few rough edges. Eventually those should get smoothed off and the internal markup/comments should grow. But so far (and for the immediate future)

• expanding the “user’s guide” and
• agressively leveraging type hint annotations so that modern editors can “help” users
• with full autocompletion
• and error flagging (especially with static type analysis)
• so users are assisted in properly using an API they aren’t even aware of have been higher priorities

However, for experienced Python developers or the brave souls interested in seeing how the sausage is made (and maybe even adding new flavors), the extracted docs are (should be) available at https://www.lumensalis.com/Projects/LCPF/LCPFDocs/Dev/Api/markdown/apidocs/ 

And of course you can always use the source, Luke…