kicad-developers team mailing list archive

[John Beard <john.j.beard@xxxxxxxxx>]

In that case, here is the patch with the 48px app logo in the top left.
Doxygen recommends 55px max height, so 48px seems a handy size.

Screenshot for reference.

Cheers,

John

On Sun, Jun 17, 2018 at 5:58 PM, Wayne Stambaugh <stambaughw@xxxxxxxxx>
wrote:

> I'm OK with the short logo image.  This would probably look better than
> the redundant KiCad.
>
> On 06/17/2018 08:53 AM, John Beard wrote:
> > Sadly I don't think there is a way to set the logo alt text in doxygen
> > (so it would still read "KiCad" when the image is not displayed, for
> > screen readers, when copy-pasted and it when search engines index it).
> >
> > Alternatively, use the square icon rather than the text logo and keep
> > the title as it is?
> >
> > Cheers,
> >
> > John
> >
> > On Wed, Jun 13, 2018 at 11:18 PM, Wayne Stambaugh <stambaughw@xxxxxxxxx
> > <mailto:stambaughw@xxxxxxxxx>> wrote:
> >
> >     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 <john.j.beard@xxxxxxxxx
> >         <mailto:john.j.beard@xxxxxxxxx> <mailto:john.j.beard@xxxxxxxxx
> >         <mailto:john.j.beard@xxxxxxxxx>>>:
> >
> >             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
> >             <stambaughw@xxxxxxxxx <mailto:stambaughw@xxxxxxxxx>
> >         <mailto:stambaughw@xxxxxxxxx <mailto:stambaughw@xxxxxxxxx>>>
> 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
> >         <https://launchpad.net/~kicad-developers>
> >                 <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >                  > Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
> >                 <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
> >                  > Unsubscribe : https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>
> >                 <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >                  > More help   : https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>
> >                 <https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>>
> >                  >
> >
> >                 _______________________________________________
> >                 Mailing list: https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>
> >                 <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >                 Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
> >                 <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
> >                 Unsubscribe : https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>
> >                 <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >                 More help   : https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>
> >                 <https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>>
> >
> >
> >
> >             _______________________________________________
> >             Mailing list: https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>
> >             <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >             Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>
> >             <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx
> >         <mailto:kicad-developers@xxxxxxxxxxxxxxxxxxx>>
> >             Unsubscribe : https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>
> >             <https://launchpad.net/~kicad-developers
> >         <https://launchpad.net/~kicad-developers>>
> >             More help   : https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>
> >             <https://help.launchpad.net/ListHelp
> >         <https://help.launchpad.net/ListHelp>>
> >
> >
> >
>

From 63ed9907b0991e25db57e72a263ea64adec200fb Mon Sep 17 00:00:00 2001
From: John Beard <john.j.beard@xxxxxxxxx>
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.

The logo is the 48px application logo, not the wordmark, as doubling the
word "KiCad" looks a little odd. 48px used as 55px is maximum recommended
height for Doxygen logos.

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 -> 2315 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 0000000000000000000000000000000000000000..a8c6dd0e4e92b121486622413442c7344ad43fb5
GIT binary patch
literal 2315
zcmV+m3H0`fP)<h;3K|Lk000e1NJLTq001xm001xu1^@s6R|5Hm00004b3#c}2nYxW
zd<bNS00009a7bBm000ie000ie0hKEb8vp<R8FWQhbW?9;ba!ELWdL_~cP?peYja~^
zaAhuUa%Y?FJQ@H12#85UK~!ko%~}gkRM#2)_U^I|-muFqAS6hPNp(=fiV9eR_((Du
zD`QNPPCK0t;?RzdX&P)}QZZ>Q#+m478;mF<(KPijRq+KRV}e1!wDnaV0VKg_h)Bf;
z3W4R`+jH)+yZ5mRdv`<h%zW-~@44rk|MC6*f6l^yw7N}LP+y9(1pE-ePSA9GGYSu`
zhXJy7Y%`+C^D`>v>^NSEJce$b%(0#4F`58s!TAOq!3dVa>Ifq~K2nAlu>cwl)5%;Z
zD%Xx8bFN~@KZ`iuH==-Afx#n7YsZOWB^c)vfYss<nd`J4>zf$z8S9+fXqk$n+25$b
z@HwqM!IHX;s9Nt7B!Sc5$kC0MO9jZvLuYRvvdH&))hdMHIFUA~g2=bLpenMSMl&dU
zX&hN3WY~PzChsINSe)yHvOIRzl%R-?$^H%QWG=)!vh+$-0!aLs<6Q!n&1S^J#Q2Qb
zh2v1aB-7)w=;&xL3<E=C8sal6pbH)8TvJ1|wxZ^5*m7<M^h6*0lmZkHo#v6P^!nmP
zjMATZzrgl>C&1G)olYkRK|i&o1R}&97_B+(jR4QLx8swl5?HA<rWT-#WigGs+OFCH
z)Z7%`ccT`dLKuxkXtW`){kRkn$pzraQWRv#jG#W$AO0&w)A7?5;V2PeGI6sD16sg2
zfq(!k0Klg)5fKpx2?-(p*C6WALRiN9g?N$9sl?%AAN7Yf;3+ybXEB-$cQKJ{^ngbT
zP{mMPdvl?oYGGkvh>D65`k{%>Aa-IopbK}Co5Me=*JGIwp_ZYu!-lzJJL?q!a83(I
z9{8?NPr~{-p1KkZ6x6kh<_rwW+Jm5wWamD#gc!xu>#%u85%dcdfStY=OUU<&iGY0~
z7wVOenC0CZ@W+MJ3LO*_1dGMePwqs-W$b{#JW1^1d0`PaT(!nQ?iow4LBnG<dG!pz
z1>!>mj4Vs4cA@GQCt&aVMD%@k7d^MG3;mB4PVm{Cv|6nogg|cMMsexo2!HVB;yq<@
zTGUm(<skQrrKp;<6k`cS&0LC|jFKGcG~au>1NP1v&@fuT9caI&^QNjfXhNj!M7hC(
zfqC>F5j|=-1W$5UBAG;^x`S_Fjv~5A!xFEW1HvRhdd%D3fu9m+v^v$U<V1LQxDaZE
zXqEH}#7@{q<_mQyH;j1p?)_^V<aP<5s4i7<K<@kga6t@{$s}ZNY89h76Y-O`L2Hb6
zk(+!J?|T!al-!VqQI_KaCU2kuILU3Z*@Vxa(1$TBlaM=Vyf|~eU<gL#z9Ixm!YF>A
zJm4$2tyZgG5hf^-kh>J2@w3I=lFbI=O@?)(ak#3|d+b7Ta?=P!$qh{qtYcTfWXW>x
zm&H>IB$>@W7vlQtIP%gA)D}KL=3u`!0i2-aheNSMC|#u33XuVa(f-}yM#H~x{d~R9
z=Z6&X1C2P0`k}du;sbc>?RrOzlQc@`XOiy*dgt1yPw}7C&r9(68_%KswOk2W4wWn3
z<phYUQAk}#EeA}t2N4qgP=7u!2z`_FfdSv?y4r%)qkAQ2`&Sj(PuEEB-;&?qi>-eq
z`{D+$04G1B`(I9Xw_m~8O}`%$9p~$W@wSOiAbsU7j~M-8v5+7y?plk}>lcBw_d1j-
zvH(j3fULd_M1bC#?YMMs%b>V@>4GrcWJ!QIWr{~w#!Z7UI$jue{mf^uceE-j04E3h
zi9#pV<l)rX0*L@db3DesvTaaU)20jKTMm@sP_E4*Y6{ZP)z*UW<P=OQJ_wyT!6ks#
zGqIXHaP9aZT>HFI=(p^9hhAa8e&;4EX*q);I4+rF*hmGm#t=y|v!*|e^f&fEA7%3#
ziR85qRB*uA8s2{$U%a~lTD=KlU)to;yKz&WMt1pm1#-4FVdl<O7gAp?14HKJCFc~`
ziA;W=@mT=+4k1=cMG167dugwJ2y<%o5a$5C|Kh=2Juna->N&Rs+KyGAc2R~`@MJL0
z^$8&}{ZAE$7&(5(H}5fwvb^+W&S|Q??oM>KUGfUYXyAdlzlJGxxYq?Qez+P9Wv>Q|
z&Xd(%5}B8qxw!0Sk@JtsUO|pvf&h(Mmg92OyI!lxZ$I5GJP!m{s^3F*^9dyfcn=2}
zHI*XGyfoP~mcNEZLS)`U^b!(Q##~HZ_gO%QoSE<9fcIKRR!R)k=s7s`mA{h^7=_D~
zWoRIRcxpORs8DiTtKW~W_rK%9w?}pf-&1JyMzqyccm>bs97=&K4|vPOgO$WIHtQp;
z2!A*YX+^uBB}b&IM|TgBI}YHRkGHwdR_h+${l8XxxqXdSuwAzuij`Y{<@~#u%h*td
zNo#9_esKH<=p$mFGlmZMj&;%;B+UAi3$`h_ZYu?cA$rVDyaGCXKZ!9wH5%y69K9bO
z;KY_Vdm%>rvdD#`+@<cSmSpEK%ii~hl*0F*F@=lv<-_gty*?Amo9h~%<0T#={e8fX
zYP9pKv$%2YnDE;GXYUdE6mm<_tlihuseq?BX`Z>&bW#Gg`;LMGN)q!>eIs#k>q?wn
z^&Bas+hD(aUFcKD+vUnFsLfANppO)Q@^)#@2AnLK=fbI#x#(?eaA#ss<siM4@Z(T#
zCZ%!gV?R^CS49j|D0&<RPd{*Yxta5&B|Mprk$I~Wkhh3O(vdX(w+b)@lVYrq<OLd@
z#n2c+yd*M66PZ&|yWNhSo}Pd)=JkC@c=}}+5=X)Ic)kL5vH|%!wplOWN6S8N;nBiv
zV64fmQo?I3B<4VKb2Azm8Un_}D_7C<)z<;d(b(81xs{Nd2gD@i*dFwDUA?ct*}J7D
zGV!l~cRJ3asV4uv#;vw`u?w|O60acA-1X-VJ?=5=EU<+6!$zEh2B{jLoLJ-x!I$?r
l&XN6opwVLd^0)EH{{fD$j5wpN5DNeR002ovPDHLkV1nSfYRLcq

literal 0
HcmV?d00001

diff --git a/Doxyfile b/Doxyfile
index 326c6848b..473aea1d0 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -45,7 +45,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           = Documentation/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/pcbnew/CMakeLists.txt b/pcbnew/CMakeLists.txt
index b690359ab..e96e2c7d5 100644
--- a/pcbnew/CMakeLists.txt
+++ b/pcbnew/CMakeLists.txt
@@ -533,7 +533,10 @@ if( DOXYGEN_FOUND )
         # Create doxygen-python html
         add_custom_target( doxygen-python
             ${CMAKE_COMMAND} -E remove_directory doxygen-python
-            COMMAND ${CMAKE_COMMAND} -E env PYTHON_SOURCES_TO_DOC=${DOXYGEN_PYTHON_SOURCES_STR} ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_python
+            COMMAND ${CMAKE_COMMAND} -E env
+                PYTHON_SOURCES_TO_DOC=${DOXYGEN_PYTHON_SOURCES_STR}
+                CMAKE_SOURCE_DIR=${CMAKE_SOURCE_DIR}
+                ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_python
             WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
             DEPENDS Doxyfile_python
             DEPENDS xml-to-docstrings
diff --git a/pcbnew/Doxyfile_python b/pcbnew/Doxyfile_python
index c06292721..a2ce2f7b6 100644
--- a/pcbnew/Doxyfile_python
+++ b/pcbnew/Doxyfile_python
@@ -51,7 +51,7 @@ PROJECT_BRIEF          =
 # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
 # to the output directory.
 
-PROJECT_LOGO           =
+PROJECT_LOGO           = $(CMAKE_SOURCE_DIR)/Documentation/kicad_doxygen_logo.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
-- 
2.17.1

Attachment: docs_with_small_logo.png
Description: PNG image