John,
Everything looked good so I merged your patch set. Thank you for your
contribution to KiCad.
Cheers,
Wayne
On 6/13/2018 7:59 AM, John Beard wrote:
> Hi,
>
> Here's an update patch set that adds to the existing Pcbnew Python docs.
> It seems to work quite well (see screenshot).
>
> I
On 6/12/2018 9:47 AM, Nick Østergaard wrote:
> I am not sure if this will slightly derail this patch's topic. Sorry if
> that is the case and tell me to back off.
>
> There have been multiple attempts on getting the python API in better
> shape. Originally it was Ajo and some others with
>
Hi Thomas,
I would like to see KiCad finally have a high level Python api as part
of v6. It's something that has been long over due. If anyone wants to
help Thomas out, the help would be appreciated. I would prefer that the
development discussion for this stay on this mailing list for the sake
Hi
As Nick already mentioned, I did one of the last attempts of a
high-level abstraction. The goal would be to have this as proposal for
an official API in the KiCad 6 release (and I will likely carry on with
the work on July).
My goal would be to have a "pythonic" and natural to use API, which
Hi John,
Ok, thank your for your clarification. For the record, I am not opposing
the change, but would just mention it looks strange to add it to the
doxygen-docs target when we have the doxygen-python target.
Nick
2018-06-12 16:11 GMT+02:00 John Beard :
> Hi Nick,
>
> It's a related concept,
Hi Nick,
It's a related concept, certainly. The drawing helper stuff acts as a
"buffer" between the Pcbnew API and the plugin writer, but this isn't
really a design aim, it's just a side effect. It certainly does not totally
insulate the writer from the Pcbnew API as it's a very limited subset of
On 6/12/2018 9:34 AM, John Beard wrote:
> Hi Nick and Wayne,
>
> The patches as they are don't hook into the existing Python API doxygen
> stuff as it's not exactly the same as the Python API, it's a helper
> layer on top of that, and I was't sure if that would be OK.
>
> I will take a look at
I am not sure if this will slightly derail this patch's topic. Sorry if
that is the case and tell me to back off.
There have been multiple attempts on getting the python API in better
shape. Originally it was Ajo and some others with
https://github.com/kicad/kicad-python
But the most recent work
Hi Nick and Wayne,
The patches as they are don't hook into the existing Python API doxygen
stuff as it's not exactly the same as the Python API, it's a helper layer
on top of that, and I was't sure if that would be OK.
I will take a look at adding it to the existing Python doc generation if
We already have doxygen generation for the python API, although people say
that it is easier to read the C++ one. It is generated with
the doxygen-python make target. See
http://docs.kicad-pcb.org/doxygen-python/
Does the additions in 0002 add to the normal python docs?
2018-06-12 15:07
Hey John,
I like the idea of using doxygen to document the python plugins. The
current Doxyfile does not include .py files so that would need to
change. Before we do that, I would like to see a new section (maybe
"Python Plugins") added to the documentation to separate the python
plugin code
Hi,
Here is a simple patch sequence for the Python Footprint Wizard helpers:
1) Minor spelling and formatting tidy-up
2) Add docstrings for the wizard base. As this is intended to be used
by writers of new plugins, having the functions documented is probably
a Good Idea (TM)
3) Add rounded
12 matches
Mail list logo
