kicad-developers team mailing list archive

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

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 <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.

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 0000000000000000000000000000000000000000..c7a1b0f85136811ebc095ee5dee7f684f394b834
GIT binary patch
literal 2793
zcmV<F3KsQ=P)<h;3K|Lk000e1NJLTq004&o001`#1^@s6CM{Wi00004b3#c}2nYxW
zd<bNS00009a7bBm000H>000H>0l&BdOaK4?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&Th=+F>~+i+<ld~=lo~S?#|54-2c1({r~^|cP$pPnaylw`@d|+Ww{CESO%b3
z77@gSW?Swwd&O)PfFT*cI0k|O#0#H4i#(S0W)Iz{V9d6}0|*r@zzCEDW-r~SaO7Av
zYJh>I9sufT_EZ?!-OkK-PRLrsIVUfTv~*9Dm)Ff~Ur&GotsEm9P|kt-?j}sNn_3J}
z<D6Na#yPW4G>FhU1ChYMvN$cN={zCpU#1pA)S!b;;ZC-vypH(PB@q>8>YJ!?`fWrw
zJYy%o{Vr|<<g}^95W~^y!S_(oLz^Nl>)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&Y+sjq`&^prhqUZ?-?
zwaAtBH#B(Eiq_v7grl21vkP=wI&{z*FnTt@>u2!(8=D{<@V%Fx21&J~cy5kmK;Rkv
z&IArIXFqCaK*V<N$R*T!nEJ>cIe9mtZR@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{l5<tWYkaupjHdNr2?s#Y2RfqE
z02qOC9jwWu*s&bqv&`VYqnXtDj#i%r-rrtCJpT|_r#>U|j5)59aM&D@3p${h5g2%y
z`8<~V5T<Y}d-q#S#a;)eL``AYa|?(*OX-EHD0RYi<53L-99CW$1|3kx4h-p9SBIOA
zEuVuS97}_QW4L=4s;sKjJolQn9*xc3%O>O{z|on{aKOV~)uH$^AO#Su9D&#JwvGX3
zHaqql(g?%RKkY+QSX`lb9=0eXN0u2JVD{m`4^aTo0M=z0XHWlCv-4f9n{XHl-{%J$
zyBoe~XTqTa4(wF!*jGaIGghuY!8B2pIApyl9H8*26kxz~Bc~DiwjCVzXOJ?hkP#P~
zp=<=<ShVse5sU+eE~4b&o5KP}a&qR6;GzFR;aEONof~OsS!fzqFPMfBI9~h%$IF>Y
zs#=g9w+fO7PV(<NC1l-YRPh~qO!#RW?|uM6>?{abpHi;Pi}zcTGjEGH9GP=ILG|_8
z9%#w=tD4!=mVV2n%U)D*rB+o6iz+nXunO`R3afD#PaP~r=-r9wKjWMk12F{tBwHnE
zO2bnh=MblH{ahXN{8ksc)D6yEg&ky-YuDh+DBMerh`=#8eFwT+?$tc@>a{xLdMsa;
zMcA5uM)R8IE>>&80i*K+3ah~^PoY>UpA%~&3OZ%AXY{5^YKafS@l}-9t@JGmgb@y$
z=Qw(zjOc*QoTuLbUAW?C&~Wg)>lTU#<yxnNiMKPJ*OxK~lPfuAx|8rbll&G3u@lB{
zY~FR6=w~cndpsy#;>9-(2Mq_zzrP`Nh9K_>fz#KEk+Ke3ES~lnzfr>$490NKw9gJ+
z2-*Q9t;=Y^0duTO>I^t$eux&hK4GCOt3w{40>`K9!3Z-P#U)qJePgx;9fcTy10MEy
zA{>JJNGRaIMKjG-a(QVPE(w6wd-15pN>>){NN@=9YL%5_8fBjad0WZd@X{Ai1xHnN
z9ZH+J$54oB$Z|NO6~xZBi-SS|M~@!UZiVY_;RJD%RwRU%{|Wb4-0B<vhCE$L@8NrB
zexAEOd{-D1aNw0zqxlPimg8Nb<#1&5jbu^^*M*SoF;L0=yiFNF!6mrrE8<BoQiPH{
z_dw*}fYC!Xqwd7W<}5w!;Xb@t_lT?1nw0BKB>O31Zd7DQN$vY`FB&v)dqm*y&GQ7y
z;mjBq(sXsayQftUC0u@}Of$Z@|2WQNfSmNduhqWCrjXW`^&|lA6#K;l9F5URu!TGZ
zqm}t&hZKB*5H!W%#H+e2A{Ou!0;bC6NXOrCkNA_AfdjW!Rve849698UmqeCO;3>e$
z%NtpSmpH-+fa7h#@ikGk@V0KtcSJbq>aL@SPkkI-IKV1|GtXg5kU6;CcdT;{E#TNd
zIKDKh;K0@5-<&EZ0&=#r3JrL8OW5GRE1eW@>|?|RUe4biio{eiI0R`c;rL@ww`4ye
zbC;6WU>)8Xfx|!2P7pe?zH?HB;eQFDu~LnB3yzoH0x0L=y)f|lnoi4+M@oD}Wj#mk
zBDyUIe_HTG*x=xJ@pW>-NSwo9J!L&X!RI);JfwB?m=enBf#V&*@!qH{_8~2?H!j`d
zjZWc!BhD@f6r=g_U4q<6@6vn=3st18U~zy(o<k2DuTV^t9itKsyicX5<O&gxV})f@
z+YyYy;qTCV3PAGl5<gv-D(2!GN{ipnD(1OJNP_8s<57zBqR~-XU_Abbk5EnRbs`||
zY$yy19GpXZkkTL68<>r3Ro%s>cZOru{;-+JF8?+_X<D14ylUX#5<Wd}_^P>x;rYjE
z#n0rmoG@%nczO8|Ch2t+aQKzCnG%q4C3)r)`zbKQyL-a>!4M@ZX=97Rp~ekOHbFk9
ztuS$hN>%(SJ#hG+<s`+_@>*c+r~;L56}TbdaNvyS-hy+6)9b9@@Q1aftiw!PB<xd|
zypXhQ5|sQ;T-Jw+fc+KmU+N8IeTtT6=_m`tTQZ76QqS?$y5q#rpFFJXLZ17_Z$o7j
zHHOmbtl(%`vSzszQW>EYarcN;U!6uMif>xOfz#vg`T2+!`>e@3MO3a<Vk>tcU3j}>
z&9_0730^AmQp4d-A`N8?2=+t#rh7+-6qee?UYxNZg0X-a4xF?iHLWd;*diP`ewoVu
zz<=DLx4;;O#d_cfD0(@|%5p%M`WNhQVhe(6DMDa5hN)DW%?|+_MO1L$=>l(bHoB<x
z(z36qtOwpZJMQu3pylm8LxgImxKkG#{*LVkoxa?_#_B8J;Js|^nR!Rxb-OynUjiUs
z>$uK-Qn?`ZG1M)gIEVfj<Z6x=-K709*byhfK^nD<?fieMmA`gUgX4w8Us12#Vjtzv
z>HC!PMrG|r-kN&iIh%H#)(uBsy#;j00?HAOJ^ca*6{p+cC;eRQn!YU&;*<W(*s9f9
zR$hJ#C({7Zd8CxMR$?no5PywpMKmIjTBWoQM_&D09Vnjjd8%n8RwP(Bn(Z7DWV^CM
z&LPeAD{KKL$Q~S#;4O<Stpv?tTo<RDjJH4HbrhUD!xi!PvrufpRzh!w<Wk_}rRVU!
z0Kk+tT&uoASG$qnFq;X7*^I)`z0WhKdtXlsNv;V;7~ohFEq{z3lq5`9Yico6EyZ&)
vbnx%GI;RYZHHmXhzAx7QMAmF(i<$O6mIau}(J_i^00000NkvXXu0mjftFlbR

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 1463e73a7..ed2364e0e 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.0