Re: [Kicad-developers] [PATCH] Add logo to documentation

[Wayne Stambaugh]

I agree.  The double KiCad does look a bit odd but I do like the KiCad 
logo embedded in the docs.


On 06/13/2018 06:00 PM, Nick Østergaard wrote:
Maybe we need to remove the word KiCad from the title, as  it 
essentially reads  "[KiCad] KiCad Pcbnew Python Scripting"



2018-06-13 21:12 GMT+02:00 John Beard >:


Sorry, I had a line commented in a local commit to avoid a costly
re-build of the docstrings when I didn't need them to be (the doc
dependencies aren't managed by CMake, it just always runs the
targets, which is fine for CI).

The attached should be better (difference is a lack of a "# " before
DEPENDS xml-to-docstrings)

Cheers,

John

On Wed, Jun 13, 2018 at 8:04 PM, Wayne Stambaugh
mailto:stambau...@gmail.com>> wrote:

John,

I am getting the following error when I try to apply your patch:

$ git am --ignore-whitespace <

/c/Users/wstambaugh/Documents/Archive/temp/kicad/patches/0001-Documentation-add-logo-to-Doxygen-pages.patch
Applying: Documentation: add logo to Doxygen pages
error: patch failed: pcbnew/CMakeLists.txt:533
error: pcbnew/CMakeLists.txt: patch does not apply
Patch failed at 0001 Documentation: add logo to Doxygen pages
Use 'git am --show-current-patch' to see the failed patch
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am
--abort".

It appears to be choking on the pcbnew/CMakeFile.txt.  Is it
possible
that you have other changes to this file that are not in the
master branch?

Cheers,

Wayne

On 6/13/2018 1:50 PM, John Beard wrote:
 > Hi,
 >
 > This patch adds a small KiCad logo to the three doxygen
documentation
 > targets (C++, dev docs and Python docs) for a little bit more
flair.
 >
 > The image itself is put in the /Documentation dir, but it's
not really
 > important to the process where it goes.
 >
 > Cheers,
 >
 > John
 >
 >
 > ___
 > Mailing list: https://launchpad.net/~kicad-developers

 > Post to     : kicad-developers@lists.launchpad.net

 > Unsubscribe : https://launchpad.net/~kicad-developers

 > More help   : https://help.launchpad.net/ListHelp

 >

___
Mailing list: https://launchpad.net/~kicad-developers

Post to     : kicad-developers@lists.launchpad.net

Unsubscribe : https://launchpad.net/~kicad-developers

More help   : https://help.launchpad.net/ListHelp




___
Mailing list: https://launchpad.net/~kicad-developers

Post to     : kicad-developers@lists.launchpad.net

Unsubscribe : https://launchpad.net/~kicad-developers

More help   : https://help.launchpad.net/ListHelp





___
Mailing list: https://launchpad.net/~kicad-developers
Post to : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp

Re: [Kicad-developers] [PATCH] Add logo to documentation

[Nick Østergaard]

Maybe we need to remove the word KiCad from the title, as  it essentially
reads  "[KiCad] KiCad Pcbnew Python Scripting"


2018-06-13 21:12 GMT+02:00 John Beard :

> Sorry, I had a line commented in a local commit to avoid a costly re-build
> of the docstrings when I didn't need them to be (the doc dependencies
> aren't managed by CMake, it just always runs the targets, which is fine for
> CI).
>
> The attached should be better (difference is a lack of a "# " before
> DEPENDS xml-to-docstrings)
>
> Cheers,
>
> John
>
> On Wed, Jun 13, 2018 at 8:04 PM, Wayne Stambaugh 
> wrote:
>
>> John,
>>
>> I am getting the following error when I try to apply your patch:
>>
>> $ git am --ignore-whitespace <
>> /c/Users/wstambaugh/Documents/Archive/temp/kicad/patches/000
>> 1-Documentation-add-logo-to-Doxygen-pages.patch
>> Applying: Documentation: add logo to Doxygen pages
>> error: patch failed: pcbnew/CMakeLists.txt:533
>> error: pcbnew/CMakeLists.txt: patch does not apply
>> Patch failed at 0001 Documentation: add logo to Doxygen pages
>> Use 'git am --show-current-patch' to see the failed patch
>> When you have resolved this problem, run "git am --continue".
>> If you prefer to skip this patch, run "git am --skip" instead.
>> To restore the original branch and stop patching, run "git am --abort".
>>
>> It appears to be choking on the pcbnew/CMakeFile.txt.  Is it possible
>> that you have other changes to this file that are not in the master
>> branch?
>>
>> Cheers,
>>
>> Wayne
>>
>> On 6/13/2018 1:50 PM, John Beard wrote:
>> > Hi,
>> >
>> > This patch adds a small KiCad logo to the three doxygen documentation
>> > targets (C++, dev docs and Python docs) for a little bit more flair.
>> >
>> > The image itself is put in the /Documentation dir, but it's not really
>> > important to the process where it goes.
>> >
>> > Cheers,
>> >
>> > John
>> >
>> >
>> > ___
>> > Mailing list: https://launchpad.net/~kicad-developers
>> > Post to : kicad-developers@lists.launchpad.net
>> > Unsubscribe : https://launchpad.net/~kicad-developers
>> > More help   : https://help.launchpad.net/ListHelp
>> >
>>
>> ___
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to : kicad-developers@lists.launchpad.net
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
>
>
> ___
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@lists.launchpad.net
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
>
>
___
Mailing list: https://launchpad.net/~kicad-developers
Post to : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp

Re: [Kicad-developers] Slash character in fp-lib-table nick names?

[Kaspar Emanuel]

Those are good reasons for not allowing slashes in the footprint names but
I don’t see any reason for not allowing them in *library* nick names. As
far as I can tell any character except : could be allowed before the :.
It’s a pretty long standing “bug” so we could view it as standard. It will
break "compatibility" with fp-lib-tables that use the slash character and
users were never warned about using it.

If it *will* be allowed in v6 why make people change it when going from v4
to v5?
​

On 13 June 2018 at 18:35, Wayne Stambaugh  wrote:

> AFAIK you cannot use slashes ('/') or colons (':') in either a library
> (footprint or symbol) table nickname or a footprint or symbol name.  If
> you could use a slash in a footprint library nickname in the past, this
> was a bug and the fact that it worked was a fluke.  The reason is that
> the library ID format is NICKNAME:FP_OR_SYM_NAME/REV.  The other issue
> is that footprint names are actually the filename sans extension.  Using
> a slash in a footprint name would render it unusable.  I am going to fix
> this as part of the new schematic and symbol library file format v6
> work.  The reason this was not done for v5 the fix will require
> schematic, board, and footprint file format changes which I didn't not
> want to do for v5 as we were already late into the development cycle.
>
> On 6/13/2018 2:19 PM, Kaspar Emanuel wrote:
> > Sorry to bring this up again but it just strikes me as a bit odd. Can we
> > not allow slash characters in the fp-lib-table as before and not break
> > backwards compatibility? It seems to read fp-lib-tables with slashes
> > fine but current KiCad nightly won't let me edit it. I am up for making
> > a patch if there's a chance it could make it into v5.
> >
> >
> > On 10 May 2018 at 12:07, Wayne Stambaugh  > > wrote:
> >
> > On 5/8/2018 6:27 PM, Kaspar Emanuel wrote:
> > > I see, thanks for the info Wayne. So enforcing this for names in
> > > _footprint_ lib-tables is simply done for code sharing?
> > >
> > > If I understand you correctly short-lived means for the lifetime
> of v5?
> >
> > This is correct.  The plan is to fix this after the new schematic
> file
> > formats are implemented so it should happen some time during v6
> > development.
> >
> > >
> > > On 8 May 2018 at 22:10, Wayne Stambaugh  
> > > >>
> wrote:
> > >
> > > This was done because the schematic file format parser would
> break
> > > with the forward slash character.  I hope to fix this early in
> the
> > > v6 development but it's a pain we are going to have to live
> with
> > > until the new schematic file format is complete.  I wish I had
> the
> > > time to do it all at once but it's just wasn't in the cards.
> > I have
> > > to implement this one piece at a time.  There was an
> > announcement on
> > > this mailing list about it.  I apologize for the
> inconvenience.
> > > Hopefully it will be short lived.
> > >
> > > Cheers,
> > >
> > > Wayne
> > >
> > > On 05/08/2018 04:40 PM, Kaspar Emanuel wrote:
> > >
> > > Hi,
> > >
> > > looks like a forward slash character in nick names in the
> > > fp-lib-table is not supported any more (it can be read but
> it
> > > cannot be saved).
> > >
> > > This breaks compatibility with older fp-lib-tables
> somewhat. I
> > > have been using slashes in names to namespace fp-lib-tables
> > > created for my footprint collection
> > >  > 
> > >  > >>.
> > >
> > > Is there a good reason for not allowing slashes in names?
> > >
> > > Cheers,
> > >
> > > Kaspar
> > >
> > > ​
> > >
> > >
> > > ___
> > > Mailing list: https://launchpad.net/~kicad-developers
> > 
> > >  > >
> > > Post to : kicad-developers@lists.launchpad.net
> > 
> > >  > >
> > > Unsubscribe : https://launchpad.net/~kicad-developers
> > 
> > >  > >
> > > More help   : 

Re: [Kicad-developers] [PATCH] Add logo to documentation

[John Beard]

Sorry, I had a line commented in a local commit to avoid a costly re-build
of the docstrings when I didn't need them to be (the doc dependencies
aren't managed by CMake, it just always runs the targets, which is fine for
CI).

The attached should be better (difference is a lack of a "# " before
DEPENDS xml-to-docstrings)

Cheers,

John

On Wed, Jun 13, 2018 at 8:04 PM, Wayne Stambaugh 
wrote:

> John,
>
> I am getting the following error when I try to apply your patch:
>
> $ git am --ignore-whitespace <
> /c/Users/wstambaugh/Documents/Archive/temp/kicad/patches/
> 0001-Documentation-add-logo-to-Doxygen-pages.patch
> Applying: Documentation: add logo to Doxygen pages
> error: patch failed: pcbnew/CMakeLists.txt:533
> error: pcbnew/CMakeLists.txt: patch does not apply
> Patch failed at 0001 Documentation: add logo to Doxygen pages
> Use 'git am --show-current-patch' to see the failed patch
> When you have resolved this problem, run "git am --continue".
> If you prefer to skip this patch, run "git am --skip" instead.
> To restore the original branch and stop patching, run "git am --abort".
>
> It appears to be choking on the pcbnew/CMakeFile.txt.  Is it possible
> that you have other changes to this file that are not in the master branch?
>
> Cheers,
>
> Wayne
>
> On 6/13/2018 1:50 PM, John Beard wrote:
> > Hi,
> >
> > This patch adds a small KiCad logo to the three doxygen documentation
> > targets (C++, dev docs and Python docs) for a little bit more flair.
> >
> > The image itself is put in the /Documentation dir, but it's not really
> > important to the process where it goes.
> >
> > Cheers,
> >
> > John
> >
> >
> > ___
> > Mailing list: https://launchpad.net/~kicad-developers
> > Post to : kicad-developers@lists.launchpad.net
> > Unsubscribe : https://launchpad.net/~kicad-developers
> > More help   : https://help.launchpad.net/ListHelp
> >
>
> ___
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@lists.launchpad.net
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
>
From 48479b55392b2ba51f6ed16deccd9953f0e96688 Mon Sep 17 00:00:00 2001
From: John Beard 
Date: Wed, 13 Jun 2018 12:51:49 +0100
Subject: [PATCH 1/3] Documentation: add logo to Doxygen pages

This adds a small KiCad logo in the top left of the Doxygen pages.

For the main docs and the dev docs, this is easily done in the Doxyfile,
for the Python docs, as that is run from the binary dir, the source dir
is passed as an Environment variable.
---
 Documentation/development/Doxyfile   |   2 +-
 Documentation/kicad_doxygen_logo.png | Bin 0 -> 2793 bytes
 Doxyfile |   2 +-
 pcbnew/CMakeLists.txt|   5 -
 pcbnew/Doxyfile_python   |   2 +-
 5 files changed, 7 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/kicad_doxygen_logo.png

diff --git a/Documentation/development/Doxyfile b/Documentation/development/Doxyfile
index f005d917d..02d6b3e83 100644
--- a/Documentation/development/Doxyfile
+++ b/Documentation/development/Doxyfile
@@ -46,7 +46,7 @@ PROJECT_BRIEF  =
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO   =
+PROJECT_LOGO   = ../kicad_doxygen_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
diff --git a/Documentation/kicad_doxygen_logo.png b/Documentation/kicad_doxygen_logo.png
new file mode 100644
index ..c7a1b0f85136811ebc095ee5dee7f684f394b834
GIT binary patch
literal 2793
zcmV000H>0l?8FWQhbW?9;ba!ELWdL_~cP?peYja~^
zaAhuUa%Y?FJQ@H13T8<}K~#9!?VJmA6xA7k7qoiNwx@@x!0rTWp_tv74GC$XAeESM
zjtKH>R$hY1%xnmFh*p6Bt!D96s3KTJc?eoc5kwFokHae{sH9dzgo8rB1W3c9NFIc+
zd63)x=+F>~+i+I9sufT_EZ?!-OkK-PRLrsIVUfTv~*9Dm)Ff~Ur|kt-?j}sNn_3J}
zFhU1ChYMvN$cN={zCpU#1pA)S!b;;ZC-vypH(PB@q>8>YJ!?`fWrw
zJYy%o{Vr|<)b;$!Kj+i0i}*yg_4GBFyXk-;21b!H7fd}
ztxYf*a@wJ19?A9{J9MK72ccOVQWD2YIRqIWGjL!@8SxLad2%YMnQ_YxV4QrSE1EX$
z>89gMIEd{|e(H~Hym-OJOGsVhkEq~~X6;8a=Y38kDdV=OkN+sjq`&^prhqUZ?-?
zwaAtBH#B(Eiq_v7grl21vkP=wI&{z*FnTt@>u2!(8=D{<@V%Fx21~cy5kmK;Rkv
z*VcIe9mtZR@ucp}wQ?^jnx9;ot;01v+ILNWFHaHHvt_
z>JVS;lpy~iHsO#KF@Xbj`d7!kCn|K-U;nMCIM1tJQh~90)5+kcADwV;y(ZcG76Jt+
zwKhRqX^VHqR07WCkY8X1#|Jx$iAsG)+Nr9vd(*a{l5U|j5)59aM@3p${h5g2%y

Re: [Kicad-developers] [PATCH] Add logo to documentation

[Wayne Stambaugh]

John,

I am getting the following error when I try to apply your patch:

$ git am --ignore-whitespace <
/c/Users/wstambaugh/Documents/Archive/temp/kicad/patches/0001-Documentation-add-logo-to-Doxygen-pages.patch
Applying: Documentation: add logo to Doxygen pages
error: patch failed: pcbnew/CMakeLists.txt:533
error: pcbnew/CMakeLists.txt: patch does not apply
Patch failed at 0001 Documentation: add logo to Doxygen pages
Use 'git am --show-current-patch' to see the failed patch
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

It appears to be choking on the pcbnew/CMakeFile.txt.  Is it possible
that you have other changes to this file that are not in the master branch?

Cheers,

Wayne

On 6/13/2018 1:50 PM, John Beard wrote:
> Hi,
> 
> This patch adds a small KiCad logo to the three doxygen documentation
> targets (C++, dev docs and Python docs) for a little bit more flair.
> 
> The image itself is put in the /Documentation dir, but it's not really
> important to the process where it goes.
> 
> Cheers,
> 
> John
> 
> 
> ___
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@lists.launchpad.net
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
> 

___
Mailing list: https://launchpad.net/~kicad-developers
Post to : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp

Re: [Kicad-developers] Slash character in fp-lib-table nick names?

[Wayne Stambaugh]

AFAIK you cannot use slashes ('/') or colons (':') in either a library
(footprint or symbol) table nickname or a footprint or symbol name.  If
you could use a slash in a footprint library nickname in the past, this
was a bug and the fact that it worked was a fluke.  The reason is that
the library ID format is NICKNAME:FP_OR_SYM_NAME/REV.  The other issue
is that footprint names are actually the filename sans extension.  Using
a slash in a footprint name would render it unusable.  I am going to fix
this as part of the new schematic and symbol library file format v6
work.  The reason this was not done for v5 the fix will require
schematic, board, and footprint file format changes which I didn't not
want to do for v5 as we were already late into the development cycle.

On 6/13/2018 2:19 PM, Kaspar Emanuel wrote:
> Sorry to bring this up again but it just strikes me as a bit odd. Can we
> not allow slash characters in the fp-lib-table as before and not break
> backwards compatibility? It seems to read fp-lib-tables with slashes
> fine but current KiCad nightly won't let me edit it. I am up for making
> a patch if there's a chance it could make it into v5.
> 
> 
> On 10 May 2018 at 12:07, Wayne Stambaugh  > wrote:
> 
> On 5/8/2018 6:27 PM, Kaspar Emanuel wrote:
> > I see, thanks for the info Wayne. So enforcing this for names in
> > _footprint_ lib-tables is simply done for code sharing?
> > 
> > If I understand you correctly short-lived means for the lifetime of v5?
> 
> This is correct.  The plan is to fix this after the new schematic file
> formats are implemented so it should happen some time during v6
> development.
> 
> > 
> > On 8 May 2018 at 22:10, Wayne Stambaugh  
> > >> wrote:
> >
> >     This was done because the schematic file format parser would break
> >     with the forward slash character.  I hope to fix this early in the
> >     v6 development but it's a pain we are going to have to live with
> >     until the new schematic file format is complete.  I wish I had the
> >     time to do it all at once but it's just wasn't in the cards. 
> I have
> >     to implement this one piece at a time.  There was an
> announcement on
> >     this mailing list about it.  I apologize for the inconvenience. 
> >     Hopefully it will be short lived.
> >
> >     Cheers,
> >
> >     Wayne
> >
> >     On 05/08/2018 04:40 PM, Kaspar Emanuel wrote:
> >
> >         Hi,
> >
> >         looks like a forward slash character in nick names in the
> >         fp-lib-table is not supported any more (it can be read but it
> >         cannot be saved).
> >
> >         This breaks compatibility with older fp-lib-tables somewhat. I
> >         have been using slashes in names to namespace fp-lib-tables
> >         created for my footprint collection
> >          
> >          >>.
> >
> >         Is there a good reason for not allowing slashes in names?
> >
> >         Cheers,
> >
> >         Kaspar
> >
> >         ​
> >
> >
> >         ___
> >         Mailing list: https://launchpad.net/~kicad-developers
> 
> >          >
> >         Post to     : kicad-developers@lists.launchpad.net
> 
> >          >
> >         Unsubscribe : https://launchpad.net/~kicad-developers
> 
> >          >
> >         More help   : https://help.launchpad.net/ListHelp
> 
> >          >
> > 
> > 
> >     ___
> >     Mailing list: https://launchpad.net/~kicad-developers
> 
> >      >
> >     Post to     : kicad-developers@lists.launchpad.net
> 
> >      >
> >     Unsubscribe : 

Re: [Kicad-developers] Slash character in fp-lib-table nick names?

[Kaspar Emanuel]

Sorry to bring this up again but it just strikes me as a bit odd. Can we
not allow slash characters in the fp-lib-table as before and not break
backwards compatibility? It seems to read fp-lib-tables with slashes fine
but current KiCad nightly won't let me edit it. I am up for making a patch
if there's a chance it could make it into v5.


On 10 May 2018 at 12:07, Wayne Stambaugh  wrote:

> On 5/8/2018 6:27 PM, Kaspar Emanuel wrote:
> > I see, thanks for the info Wayne. So enforcing this for names in
> > _footprint_ lib-tables is simply done for code sharing?
> >
> > If I understand you correctly short-lived means for the lifetime of v5?
>
> This is correct.  The plan is to fix this after the new schematic file
> formats are implemented so it should happen some time during v6
> development.
>
> >
> > On 8 May 2018 at 22:10, Wayne Stambaugh  > > wrote:
> >
> > This was done because the schematic file format parser would break
> > with the forward slash character.  I hope to fix this early in the
> > v6 development but it's a pain we are going to have to live with
> > until the new schematic file format is complete.  I wish I had the
> > time to do it all at once but it's just wasn't in the cards.  I have
> > to implement this one piece at a time.  There was an announcement on
> > this mailing list about it.  I apologize for the inconvenience.
> > Hopefully it will be short lived.
> >
> > Cheers,
> >
> > Wayne
> >
> > On 05/08/2018 04:40 PM, Kaspar Emanuel wrote:
> >
> > Hi,
> >
> > looks like a forward slash character in nick names in the
> > fp-lib-table is not supported any more (it can be read but it
> > cannot be saved).
> >
> > This breaks compatibility with older fp-lib-tables somewhat. I
> > have been using slashes in names to namespace fp-lib-tables
> > created for my footprint collection
> >  > >.
> >
> > Is there a good reason for not allowing slashes in names?
> >
> > Cheers,
> >
> > Kaspar
> >
> > ​
> >
> >
> > ___
> > Mailing list: https://launchpad.net/~kicad-developers
> > 
> > Post to : kicad-developers@lists.launchpad.net
> > 
> > Unsubscribe : https://launchpad.net/~kicad-developers
> > 
> > More help   : https://help.launchpad.net/ListHelp
> > 
> >
> >
> > ___
> > Mailing list: https://launchpad.net/~kicad-developers
> > 
> > Post to : kicad-developers@lists.launchpad.net
> > 
> > Unsubscribe : https://launchpad.net/~kicad-developers
> > 
> > More help   : https://help.launchpad.net/ListHelp
> > 
> >
> >
>
___
Mailing list: https://launchpad.net/~kicad-developers
Post to : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp

[Kicad-developers] [PATCH] Add logo to documentation

[John Beard]

Hi,

This patch adds a small KiCad logo to the three doxygen documentation
targets (C++, dev docs and Python docs) for a little bit more flair.

The image itself is put in the /Documentation dir, but it's not really
important to the process where it goes.

Cheers,

John
From 3579685855ce1f022ce50fbed5294b67d730510f Mon Sep 17 00:00:00 2001
From: John Beard 
Date: Wed, 13 Jun 2018 12:51:49 +0100
Subject: [PATCH] Documentation: add logo to Doxygen pages

This adds a small KiCad logo in the top left of the Doxygen pages.

For the main docs and the dev docs, this is easily done in the Doxyfile,
for the Python docs, as that is run from the binary dir, the source dir
is passed as an Environment variable.
---
 Documentation/development/Doxyfile   |   2 +-
 Documentation/kicad_doxygen_logo.png | Bin 0 -> 2793 bytes
 Doxyfile |   2 +-
 pcbnew/CMakeLists.txt|   5 -
 pcbnew/Doxyfile_python   |   2 +-
 5 files changed, 7 insertions(+), 4 deletions(-)
 create mode 100644 Documentation/kicad_doxygen_logo.png

diff --git a/Documentation/development/Doxyfile b/Documentation/development/Doxyfile
index f005d917d..02d6b3e83 100644
--- a/Documentation/development/Doxyfile
+++ b/Documentation/development/Doxyfile
@@ -46,7 +46,7 @@ PROJECT_BRIEF  =
 # exceed 55 pixels and the maximum width should not exceed 200 pixels.
 # Doxygen will copy the logo to the output directory.
 
-PROJECT_LOGO   =
+PROJECT_LOGO   = ../kicad_doxygen_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
 # base path where the generated documentation will be put.
diff --git a/Documentation/kicad_doxygen_logo.png b/Documentation/kicad_doxygen_logo.png
new file mode 100644
index ..c7a1b0f85136811ebc095ee5dee7f684f394b834
GIT binary patch
literal 2793
zcmV000H>0l?8FWQhbW?9;ba!ELWdL_~cP?peYja~^
zaAhuUa%Y?FJQ@H13T8<}K~#9!?VJmA6xA7k7qoiNwx@@x!0rTWp_tv74GC$XAeESM
zjtKH>R$hY1%xnmFh*p6Bt!D96s3KTJc?eoc5kwFokHae{sH9dzgo8rB1W3c9NFIc+
zd63)x=+F>~+i+I9sufT_EZ?!-OkK-PRLrsIVUfTv~*9Dm)Ff~Ur|kt-?j}sNn_3J}
zFhU1ChYMvN$cN={zCpU#1pA)S!b;;ZC-vypH(PB@q>8>YJ!?`fWrw
zJYy%o{Vr|<)b;$!Kj+i0i}*yg_4GBFyXk-;21b!H7fd}
ztxYf*a@wJ19?A9{J9MK72ccOVQWD2YIRqIWGjL!@8SxLad2%YMnQ_YxV4QrSE1EX$
z>89gMIEd{|e(H~Hym-OJOGsVhkEq~~X6;8a=Y38kDdV=OkN+sjq`&^prhqUZ?-?
zwaAtBH#B(Eiq_v7grl21vkP=wI&{z*FnTt@>u2!(8=D{<@V%Fx21~cy5kmK;Rkv
z*VcIe9mtZR@ucp}wQ?^jnx9;ot;01v+ILNWFHaHHvt_
z>JVS;lpy~iHsO#KF@Xbj`d7!kCn|K-U;nMCIM1tJQh~90)5+kcADwV;y(ZcG76Jt+
zwKhRqX^VHqR07WCkY8X1#|Jx$iAsG)+Nr9vd(*a{l5U|j5)59aM@3p${h5g2%y

Re: [Kicad-developers] [PATCH] Python FP wizard helper: docstrings and rounded/chamfered rects

[Wayne Stambaugh]

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 have also added docs for the PadArray module and fixed a doxygen
> warning about obsolete parameters.
> 
> Cheers,
> 
> John
> 
> On Tue, Jun 12, 2018 at 3:02 PM, Wayne Stambaugh  > wrote:
> 
> 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 adding it to the existing Python doc generation if
> > that's an acceptable way to present it.
> 
> This makes more sense to me than adding it to the c++ source
> documentation.
> 
> > 
> > Cheers,
> > 
> > John
> > 
> > On Tue, Jun 12, 2018 at 2:11 PM, Nick Østergaard  
> > >> wrote:
> > 
> >     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 GMT+02:00 Wayne Stambaugh  
> >     >>:
> >
> >         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 from the c++ source documentation.  I can commit
> >         your patch
> >         as is and you can make the doxygen changes in a later
> patch or I can
> >         wait for you to create a new patch with all of the
> changes.  I'm
> >         fine
> >         either way.
> >
> >         Cheers,
> >
> >         Wayne
> >
> >         On 6/4/2018 7:33 AM, John Beard wrote:
> >         > 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 rectangle and chamfered rectangle helpers.
> >         Useful for
> >         > some footprints or even board outlines.
> >         >
> >         > I used Doxygen-style docstrings, but I haven't actually done
> >         anything
> >         > about building actual output docs with it. Any thoughts
> of if that
> >         > should be done, and if so, where to put it?
> >         >
> >         > There shouldn't be anything here that will break existing
> >         plugins, the
> >         > only API changes are additions.
> >         >
> >         > Cheers,
> >         >
> >         > John
> >         >
> >         >
> >         >
> >         > ___
> >         > Mailing list: https://launchpad.net/~kicad-developers
> 
> >          >
> >         > Post to     : kicad-developers@lists.launchpad.net
> 
> >          >
> >         > Unsubscribe : https://launchpad.net/~kicad-developers
> 
> >          >
> >         > More help   : https://help.launchpad.net/ListHelp
> 
> >          

Re: [Kicad-developers] Build failed in Jenkins: kicad-qa #4256

[Maciej Sumiński]

For the record: the issue has been already fixed by Jean-Pierre and was
not really related to the documentation fixes. Thank you!

Cheers,
Orson

On 06/12/2018 04:28 PM, Miguel Angel Ajo wrote:
> See 
> 
> Changes:
> 
> [Wayne Stambaugh] Minor Python scripting documentation fixes.
> 
> --
> Started by an SCM change
> Building remotely on debian8 (clang gcc linux) in workspace 
> 
>  > git rev-parse --is-inside-work-tree # timeout=10
> Fetching changes from the remote Git repository
>  > git config remote.origin.url 
> https://github.com/KiCad/kicad-source-mirror.git # timeout=10
> Fetching upstream changes from 
> https://github.com/KiCad/kicad-source-mirror.git
>  > git --version # timeout=10
>  > git fetch --tags --progress 
> https://github.com/KiCad/kicad-source-mirror.git 
> +refs/heads/*:refs/remotes/origin/*
>  > git rev-parse refs/remotes/origin/master^{commit} # timeout=10
>  > git rev-parse refs/remotes/origin/origin/master^{commit} # timeout=10
> Checking out Revision ade3c2b12921a01360c75ad7e5a77371ae6d4f0e 
> (refs/remotes/origin/master)
>  > git config core.sparsecheckout # timeout=10
>  > git checkout -f ade3c2b12921a01360c75ad7e5a77371ae6d4f0e
> Commit message: "Minor Python scripting documentation fixes."
>  > git rev-list --no-walk 660aed71b4e21c7e3052c665accf1d36ad612a13 # 
> timeout=10
> [kicad-qa] $ /bin/sh -xe /tmp/jenkins1165005224288930315.sh
> + cmake --version
> cmake version 3.0.2
> 
> CMake suite maintained and supported by Kitware (kitware.com/cmake).
> + gcc --version
> gcc (Debian 4.9.2-10+deb8u1) 4.9.2
> Copyright (C) 2014 Free Software Foundation, Inc.
> This is free software; see the source for copying conditions.  There is NO
> warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
> 
> + git --version
> git version 2.1.4
> + OPTS= -DCMAKE_BUILD_TYPE=Debug -DBUILD_GITHUB_PLUGIN=ON 
> -DKICAD_SCRIPTING=ON -DKICAD_SCRIPTING_MODULES=ON 
> -DKICAD_SCRIPTING_WXPYTHON=ON
> + [ -d passed-qa ]
> + [ -d build ]
> + cd build
> + /usr/bin/cmake .. -DCMAKE_BUILD_TYPE=Debug -DBUILD_GITHUB_PLUGIN=ON 
> -DKICAD_SCRIPTING=ON -DKICAD_SCRIPTING_MODULES=ON 
> -DKICAD_SCRIPTING_WXPYTHON=ON
> -- Kicad install dir: 
> -- Check for installed GLEW -- found
> -- Boost version: 1.55.0
> -- Check for installed Python Interpreter -- found
> -- Python module install path: lib/python2.7/dist-packages
> -- wxPython version 3.0 found.
> -- S3DSG version: 2.0.0
> -- Boost version: 1.55.0
> -- Found the following Boost libraries:
> --   unit_test_framework
> -- Boost version: 1.55.0
> -- Found the following Boost libraries:
> --   unit_test_framework
> -- Boost version: 1.55.0
> -- Found the following Boost libraries:
> --   unit_test_framework
> -- Configuring done
> -- Generating done
> -- Build files have been written to: 
> 
> + echo CMAKE exit code is 0
> CMAKE exit code is 0
> + rm -f pcbnew/pcbnewPYTHON_wrap.cxx
> + env
> + grep -q ^MAKEJOBS=
> + echo The MAKEJOBS variable is empty
> The MAKEJOBS variable is empty
> + JOBS=4
> + make -j4 pcbnew_python_module
> [  1%] Built target pcb_plot_lexer_source_files
> [  1%] [  1%] Built target lib_table_lexer_source_files
> Built target pcb_lexer_source_files
> [  1%] Built target netlist_lexer_source_files
> [  1%] Built target idf3
> [  1%] [  1%] Built target page_layout_lexer_source_files
> Generating version string header
> -- Using Git to determine build version string.
> -- Found Git: /usr/bin/git (found version "2.1.4") 
> [  4%] Built target gal
> [  7%] Built target kicad_3dsg
> -- Writing 
>  file 
> with version: (5.0.0-rc2-127-gade3c2b)
> [  7%] [  7%] Built target lib_dxf
> Built target version_header
> [  7%] Built target polygon
> [ 49%] Built target bitmaps
> [ 49%] Built target specctra_lexer_source_files
> [ 53%] Built target pcbcommon
> [ 54%] Built target pcad2kicadpcb
> [ 60%] Built target 3d-viewer
> Scanning dependencies of target common
> [ 61%] Building CXX object common/CMakeFiles/common.dir/build_version.cpp.o
> [ 83%] Built target pcbnew_kiface_objects
> Linking CXX static library libcommon.a
> [ 97%] Built target common
> [ 97%] Built target github_plugin
> [100%] Built target pnsrouter
> Linking CXX shared module _pcbnew.kiface
> [100%] Built target pcbnew_kiface
> [100%] Creating python's pcbnew native module _pcbnew.so for command line use.
> [100%] Built target pcbnew_python_module
> + pwd
> + export PYTHONPATH=
> + cd ../qa
> + /usr/bin/python2 test.py
> test_pcb_bounding_box (test_002_board_class.TestBoardClass) ... FAIL
> test_pcb_find_module (test_002_board_class.TestBoardClass) ... ok
> test_pcb_get_pad (test_002_board_class.TestBoardClass) ... ok
> test_pcb_get_track_count 

Re: [Kicad-developers] Janitor needs a kick

[Maciej Sumiński]

Whoops! Apparently trying to change status of a non-existent bug report
drove him insane. He has already taken his pills, everything should be
back to normal soon. Sorry for the mess.

Cheers,
Orson

On 06/13/2018 02:48 AM, Seth Hillbrand wrote:
> I don't think it was my formatting but the last two patches to master seem
> to have stuck the Janitor in a loop.
> 
> Anyone have time to reset it?
> 
> Seth
> 
> 
> 
> ___
> Mailing list: https://launchpad.net/~kicad-developers
> Post to : kicad-developers@lists.launchpad.net
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
> 




signature.asc
Description: OpenPGP digital signature
___
Mailing list: https://launchpad.net/~kicad-developers
Post to : kicad-developers@lists.launchpad.net
Unsubscribe : https://launchpad.net/~kicad-developers
More help   : https://help.launchpad.net/ListHelp