← Back to team overview

kicad-developers team mailing list archive

Re: Python scripting documentation

 

I'm also thinking about giving a try to sphinx, which is the software used
to build the python documentation at the python site.

I will drop a link here later if it looks good.

Miguel Angel Ajo Pelayo
http://www.nbee.es
+34 636 52 25 69
skype: ajoajoajo


2013/9/8 Miguel Angel <miguelangel@xxxxxx>

> I forgot about the most important part of my previous message, the link :)
>
> http://dev.kicad-pcb.org/doxygen-python-test/classpcbnew_1_1BOARD.html
>
>
>
> Miguel Angel Ajo Pelayo
> http://www.nbee.es
> +34 636 52 25 69
> skype: ajoajoajo
>
>
> 2013/9/8 Miguel Angel <miguelangel@xxxxxx>
>
>>
>> It's a first try, only "BOARD" class extended descriptions are
>> imported from the C++ doxygen.
>>
>> It's not perfect, but can be automated and much better than nothing.
>>
>> We do:
>>
>>      C++ ->doxygen-> XML  -> python_script-> .i
>>
>> then
>>
>>      *.i's ->swig-> pcbnew.py
>>
>> and finally
>>
>>     pcbnew.py -> doxygen -> html
>>
>>
>> The link came out from a test on command line, now I must spend some more
>> days to get this workflow into cmake
>>
>>
>> Miguel Angel Ajo Pelayo
>> http://www.nbee.es
>> +34 636 52 25 69
>> skype: ajoajoajo
>>
>
>

Follow ups

References