Python bindings doxygen documentation

External Plugins
1

As 6.0 was released and development started on 6.99 how is the situation with the python API documentation?

@craftyjon can we still assume from SetLayer(), TEXTE_PCB and API doc puzzles - #4 by MitjaN that:
5.1 documentation resides at: https://kicad-downloads.s3.cern.ch/doxygen-python/namespacepcbnew.html
and
6.0 documentation resides at: https://docs.kicad.org/doxygen-python/namespacepcbnew.html

Is the python API doxygen documentation for 6.99 available? And if it is, where is located? If it isn’t, could it be made available? Even if the link to documentation is transient in nature (documentation is one of CI build artifacts) I’d really appreciate the pointers how to get to it.

Thanks for the support.

2

One problem is we are demolition derbying the code base right now so the SWIG generated python api is changing every single day as a result. For example, wxPoint has been chucked out of most data objects, 6.99 now requires VECTOR2I used everywhere as the coordinate container. Angles are no longer doubles but EDA_ANGLE containers, etc, etc.

We won’t have a stable, cleanly defined, non-swig api until later. The current api is going away entirely at some point.

3

Yup, I just got a bug report when a user tried to use one of my plugins with 6.99.

Don’t get me wrong. I totally understand the fluid nature of python API.

I only thought that as 4.99 (pre V5), 5.x and 5.99 had doxygen python API documentation generated with CI pipeline, that 6.99 might also have this. It is easier to browse through doxygen, than to browse the KiCad source code (at least for me)

4

This topic was automatically closed 90 days after the last reply. New replies are no longer allowed.