Krita Python API Documentation

Since a lot of people asked about having access to the documentation from the browser and going through h files annoying. I put together a simple html+javascript page that generates a documentation to use with the browser by pulling it from the git api (no install required):

https://knowzero.github.io/Krita-PythonPluginDeveloperTools/plugindevtools/PluginDevTools/kritadoc.html

Some weeks ago I also compiled the doxygen doc for libkis for a user in the chat:

I asked bcooksley (KDE sysadmin) about the broken api page with 404 error on IRC. They said -

first you will need to get Krita’s documentation building using kapidox. it requires you add a metadata.yaml file, similar to what Frameworks have (as well as all the other projects listed on the front of api.kde.org). Once you have that in place submit a MR to sysadmin/binary-factory-tooling, apidocs/ folder adding krita to the list there and it will be picked up in the next generation run. KApiDox - KDE Doxygen Tools has the steps

The example metainfo file can be found in the marble repo here - metainfo.yaml · master · Education / Marble · GitLab

So if someone with more knowledge than me makes that file and follows the step we would be having the api reference site up again I think.

It seems simple enough. Probably.

This is rather nice :3 Is it complete or are there things from the API that are lacking?

Thanks for making it

Everything from the api itself should be there in theory. Just be sure to select what version of Krita you use on top, as master will give you the latest nightly version which may have new apis that aren’t in the version you have.

That looks awfully specifically only meant for libraries.

Thanks to Halla & the people at sysadmin we now also have: Krita - Krita Painting application

Unfortunately, without a version picker, this isn’t super useful. I wasted a ton of time referencing that site trying to figure out why node.findChildNodes causes a silent crash.

But using KnowZero’s docs, I can now clearly see that findChildNodes didn’t exist until fairly new versions.