From 930f3dd74fca5cfbeda1fa99ea57a919467b58fd 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. 54px 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 -> 8907 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 f005d917dd..02d6b3e831 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..84bd84ff931a22a05ebd908e57a9ab2689da85de GIT binary patch literal 8907 zcmV;+A~fBJP)eKQ=iYk3A9zV|_1 zQY1yG^z@$pELO3}n+*_%I1PX_`+xrXnE&EmEjF8&O3f{2%fHxS^POL+ef~W^osIYV z{TK4w5gqo!9?}s`W2h@X_0{;Qba66bi_si>P2-yL zMEkhtmh0}geSc0zi+uFk7k+v_eYnSJD8Bi52PNvu9bZBV%P>YhOhzqeMBdxt?sMCH z-gK2GFUOhQaWjqLPhaM{gMah&exq}gy3X199xK}A6>*xOk<)k1VnEz^#Wdac-Y@eZ zZ+_$tS;z>c8|F#}yB*IhMsh!LE8KAooR@4g_9+cl*6Rj@h-W7n;{qdKvkS>(XN&j6 zIpSCupH9nth<-2vE+xO5IgCvRnZc=E&*qxq?zuks=P=O1KqQK$Ff=W61}nxy{*+kB zp`JpDCZ&{9Nj0_9bI38LoO8*-s9r*eC6!!Csil=(Lya}nTuZIB)!uvyKv-(I71L^K zt#=;Uxpn92&KbQAKf;J3jXcVzqm4dEpBZPGd6rpcn|=8e7UjS4DrVKyR^M)uN;~ef z^DevYw)-L1PB`(TlTSJIwA0^5?KP^ON6md1x!;ePdySe#EZ+0Vk5S`rDQ~xMf|H~% zW5j%PjCj!qkkDRZW~+#-8z=1AeeL3;zy4`{^}%w>kLVXY z>nD^m!d_!;V9brPOQLrKe)m|q>nC-y{F$Nk5>rp9O`_W4YHkov=Q8DJ!N#>+%!PZ* z6V@K}z*(~fY8w@wXaj@=pIl)B$1FW0tj=z*aO^x{AyHc3V6%+iiJ1dr zYE1mGZ7`lNrUI_z5yPPX*McKb;&+}0Fzcq&1aVw-hggRd2Ik0p=<_@-ol5_WODkoD zqt6i;tFS;HOV+so1!a#j`bXgrkv6 zJB-&+y5n*WYZ=>jhRM=sXSMrrTs(u3IGa{J2k#+jdg(id8H7IJun$+7KfKf(l7m>y zK+j9~(KtR;^Oh++eAnc#`v`WlN`g@`Co|f_N1u{whtY}8LC)6UY07=Fj?-OWCs^ub z&9f(s>G|HcZha@D^*PM>`ap;IU59%&U%L8Tr@oEd*Pfc6JN0w_zwhZ=r=C6;3ND{G zhpy*rDzUUS#vCN}ah1{pG?s7K0a$UZ+QFO&zLv7xz1^INGB)d`)t-t#OA+WggF4^2 zY-%r0Qps_5GMHRTs}q@-fj{4+XHqWY-8eCry&>@kmG&AlNL?c3ve$|aq>!xKoAxF! z4iU9Br9#J-zazN#FV_@HG0van^73=kwT81Jt5UYj8L}$?PxhWZZ341^*F%s>2|JX* z$kH8Zn5NHWjvo`e8Y8qt6Hny&KK4Mgok>mZkP98++MCiU*t(r-l-wQzu@RFKof!QR zu>yJK7VHc@_2GzR%wYiU1KI#pGE_jMMznoys+Lh^ERLRcHll>;x0MDn4k!1M1DH1u zDh$i28KHlsgIj23ISu3*)%RH;JVC^033x(Su9n6$fZjr$miP0Pi=<$;yFhTq17J|H z+YyS`mTaO2q_?Gcq~hzUdc1i~OpPI8w4u>^|L<;JxQUw^Dto(Yc%4UWRRflMdc3uN z)PT1$-&gT(N_=#4>6O2kF;`U5ry(v@SpjNDF8a<9CM`GVPG= zD(-Z<_aRXCY46OlEVYF)qtZy15$h5kr!+c$Wr;1sG?K3P z-V-*jV5SKib|E4D!gf?Ya8}WKNHlU>?LFJ~f$mQfc@eZVXd9B}6g^yIfL7cdc=L1Z!~Sq$fep=$-{@1JeO4TNy-x~dxv9Q zJqMNFzS7v=4ZoeyW`I-Y0WAsT2*G%AV`wMc+A z`kfNZ)?+XVRabd1*5UwqB{#dO@v6(*byF&{L~<`%R0NTlMB#8;WXqW#lFcr z=nvOaWID^@QOVRg(T)As4MlboC%UsXnvV6r#uUh;F>di77gCYTrb?xG`=W&_2Egi+ z)SiTN(t$!AGzkiux@{YZDp{xq;e!JVq0{^Vuu7-Pgqo1&8!NM~+(6cFU$kY|2?w)O z;b%+CXV~^C6JT>o3y^jl?K99Ad%1$L06+%XSsq{+!b{Sk5;C$~xsV&fR#8n16%r&M zn^ziFYS9^N0D-3Qtw7Jvc#JqZ%mYQcvW&nLR|t{|Wv~X9(9e6$`zffl=ajb-+6L$x zlAI(U(HXv|}9V zsJeNlgJ_*!P(T8cO1H`E0kl^V`tYP4kx-@J0QIRbfU+ku+#*Ahw0n`tgd=`yWvb-lPlpr>fx|l-BaW#{UW+Hcav}y750Ukgib{W_V zP(+&FrbQ|t(n6R7n#cHv?3s9a%4oKp9~K##0@QEV=?eCzqg+E0k&C#tNT;{}?#>%k zSS5C`peqtoy!l2%4MQOkH4u|$(0oU^C87?RU<)zwDEWNAzD@RqkyQDGzibuO41BC# zjLJBMvd0y8Ts>_F65|C8M-E@bfRTt6TW<21iX~9tMnYD2{0p1YVn2?pvMoF;nCD0 z2a3&V{mWbS$D7%t*w1sR>R$VH>AldrU5W2{u6?e&*SR@02e$I#IMB?f%8|UzCYjcf zN)p~L8x6e6{o^g%Rsrud9s?!BJ@=~DHS(9PJgtkb%lPwk5k-4+4MxXFlU*SeIvCcb zS3|-^5WpqP^OGb28&uGg9vH9j9SbI{&3K_I5JG`iTqf!fE10&lPdqkS`QV6B@gNT_ zOp*+4bgt(JWKeY*@8CxTk6^RyY`jL!^FNA3lVed%j`DGtes{bbXoENa0p%?qcW5?q zN}1%UKgOfZ@xc-GFAYghedG$w@T92ed(xS)E9;8Zo{{Njo(cjc{6fbGgWBFYBM*x( z>YG9&Z%e6~+eb=u>GX(`2!IQ0hv%`S~WT%)*KFQP4kpzx8F`X@ss{kM)1sxpH9+mCt}usB*4l^|2!X?x6i5c zdj@xSowF_KVEVZrl$rf{vfI1ytw}J-*I)aDpFjO%6haPnIuO=H9*_K{k#@!Is6DmZ zDHl)GJnX*jJdR_8Au?U7PoGO)7n%=OKG(gjl6#97q~NRuyFHN9e4YuNM%^Q49xj9r z&h4709O^ml(H7a=R%FcWE}rkJQpd1~Y!EktxQiQBe9rEGHQD?n3l+R?mnx!T7d zqwQ1I15KFrBi>+^wycXwQ#B|Bo-F<3G|4b0{jCJf*+8;c%u%z)V9X)Q4D1piOKZae z{c|iuYryBQAR@UpIMxsE0{j61hjw1W0ueVW@Ly0RWQ)x_k3Kq@+IOc&aR40<@{yIy z0o@xHbw=J`!Rq2aLOCS7On8b4aE@=R$Q^fKc#b5nA_>k6WqiD?J3-<|N(sp~l?oj0 z23tfSQ%tA~pmc!F(E(7X$w?1K1+<7nM#P-@nrX<~u>~y&ecJRPo=UiuwDwhtG&&UXbz=Ec_l7-q1uy^jv2C7>WJ? zQOs9ppx+E5iG#D+H}nHCj;Cl^W0ENF971$By zgbk7IYc4aQICvy7B*$27bDFR*WV6@c_dTcc`e`HMP#Q0UR5Htey*>Ia^9}&FDv@dB)s7uo_0(TWi-wY<%oC*RT_DpHa>JStlQq_0h138Td zy?M>pqyK25d(A6pVXGBQeRMXZ(rHFduxzPwCV~?`R3B;6hFoJT)c&r~R-HxCznYI09gA$OPb}r<|LeT8$rG z3l>ew|1;aVrwD7`Ntg}$%g9hIO(Jz@RntdFL}&ImLeAzlKgVJOD&jiWO^eq+v6D&) zoz_h-14mQzYba^y6s46@xD0E+g78a8OR798#O;1RB$K)#Z&buz68++~+1)GHmK>Zz z>&+t4gM~s+Yvm9oyBN-3JhhZ|dS)pJJ3X8P%1M2h_$<*M2&-ZsE{O{KKhfyVEc(u& zP*YJ|!6L8HdJ5|oWo2JAM`^7%2SL2ERTJWn%EL1lA^Edt+UYJFNKMp*#CtpAIpNF4 zD(;#p4yMlZ3iga4zXw;y@~XS?synm?grc9Itu4R$+&m|&IeC<=45-pg0a8F?X!*KX z>)*ZXx{|dBY~0HmASsWz;tSBY*S=rruXFzCs^^+}N!{5ylWirN{DSF!q-6c z!9P`VHKYkLaSg3qq2@H7)EN*XmZZS7L83O8f4CJi8;VBUJ3z7=rX!Zv?W+3$soFs~{uiQ^ZIrS{O6`CA_QN@M14dF(5VnZM<+uQX=< zmdC!*nE6{C`$}WxZ+YzNbeZ{XzKjeYF{2+84foXcCD_Ub#IbZS=2oj3WH>HNTV>Fh z+i31;Xx->)c5L?cH`yk2ff|1HYRsmU(r0BrYXxn^Q{#S?s+JanaoGn1!iDaR=A+7i zOSF2RO4Wlwh*6{~YRiWYXx!?SMYNNa=w?P1rMX(sx=8OZkmiRRt)(i@KAP8eS%3_& zP!|ek108reMCXvt(7P_cekg? ztYfa$f}2$W9K(8{vj>`+%9_LZ9_bKuf>rQ)S?~|lAd=9MzqeYf$Gun3sh}mCMuMtX z+Kq=7k)D{E9y{7fz~E<~BCRNcJ(_op&Th?c+n|2$MiF*uS&L-aRi-(=;$BL&#oApN3I$+Bo;DqC41dTJ}{jC%=EMa z6c;Mmdn)FDM!NBxQGXPM`Gry6A~ot-1^o+y{@I_K-x>7s81(P``Tx)Q{h!SGQTPfE z3fV#R+8c@Z9>*cN#yC?;N-dax3k2w9PEb1qhGUM!cTL~{4mp7)xMgkgiSB9#JZwOg zw0X2+qJX(sz-sjR#0grC9yoy@>8b@LG&zbQX^CtG2vKlxmi7Sj(tF}q(fa3^k_bT9 zHU+43i$ZMG*(`evl9$*ykKWOCRMW#^*(bN@ptF>|HY1U~NGI`oi_h*uFcyPR_DcAPxF0mVn@7L=JGW_#uj{>J6e&858+|b-4 z0j-`Uk?V1%gi#MDV^3_L&3SH*%)&B39C(=4YC`;`ShRUYS<|Zo=O@MUOAl_on(&w0 zk=Btc{+-tOq;$+TQfEFI`(H8^2=+(pyrhoWR9}MTgWCD1b$+3A%s;O${Kn9KP&(!} z>w;IuXg=oINAjj*H2?9^Iv>t3Ur+hYwf~7?F&`z%BX!F8mo*Yv$NXY#@Q+scUWPKS0x=?4QG3@m3tf#D(qvQN zyh17!Ii)g6(VU!SFtza??KVxR+5$m-Zz?kLiI%PTs3(Ei!V@`LMh$V?9X@TPa5Upb zzCwjws1)Q`Ov5tgKt*88fa1PXikQF#2rlx1;wB{M$+$GP2EwGh@Pt9L{*2Mcn8^e8 z5A8X~4LgfpMr8(JnGHw;pcHm#ZyJfhh!jKBMlP%ETb<%tlA2S=W8fRYSTzz_)dBH( zLoNkKfrb-B#O$EIXj{Y_A$d*Ew7ImLh(VKkUEQGJ9?gV?ME|ls5d8E~O$(oOv=cD3z=^f4b zX^(t!&T3ot{-Kk?ObF}^T}&y*PiklUG&52`$p6U9$e?KdBQqn~efZPN$UQY~*bFc+QS37&Px3<6{IXQ>5TvH*-~hi7aT@^hG4zbHS%)Psln(IUa3A$i`^ZB?kLy(WYx1zX=*Qsc284VWL@Xcjr{8dHILw+(8yA5 zSSe(DNeKDwaBBAMR63{7!m0gL8-g0N0u3ZRksF%xwkW<{n;>|qprc*(4seY&%QRH|GRK-NKhY2DrCkfDi0WE&mh@8{f zB3MYvX_1zA5N8xD@vl%v*VHW{o9xmn3XBT?==3I2^ET-%8f0J7E(>|f=Us_7f|)_q zB`9jr%nF!t3C-8R#C=>Wc&fsvBaB^onANsS7=#%a6LxQA^qT7B*t;+El@?!fLa8VC z5_(d9N+RvI_k~s$z4b$80|q`y`HAe5qCjKSB9<1e0Q9{XaHMj$X&3s%B=zNX<-UA* zJ98K6-Vz{Xlpcu$VlKV;6evfOKK(iZKWyi9bQN-hK+yVMCwRt9U%`M(;4%4HCRI%aQsc+ zQ8dZgDURA10t;D@hh83oEJGt}(|vk89lmEUz2A*j-vOZ@lzJv;_ZW zS*EHtW?*K2fXk#8FPEVn!FnPjp9)3v=>V#(>4}yccOKeChR@OhZDu4%hy*I7`_}22 zsCBeR3I_b93_!DnCJxjyXCmLIC%tt+(CUi!Oiom~W2!K4@8`XrWxk$f(Lw+bg{7pU zMEj5X1w3)pZF2Vr2P7B(DAUY|MrXovlD7D{oEvyJQgpw$&9|*K-?T?tarzSt`~LC! z^GVK)VCqwVTYK!a=w{~U7~Gp}tF3wec(0@8%dd9rKK#_z&t27vUh*Q;Pww|aC=dH+ zV}`6;l$u8jKmxH?4}k%BNdcx`medy|vkuJ(;20zh!?)Fp0CnE$K+gr)WU zvG1hF(7R@+Kq>_;A*=5We4Gv1$wJYZK=^tR4+Nu+6u-0;rG#RpfLHN2L9dIxyT<&@ zMc-Xx{^p|Zt}*{^m)@>1|8AGwt}*{^m)@>1|8AGwt}#Df)PK6@r_6#JNK_mI#HzU= z3K35WIcXO)u2DPowfI)`u4YocQVL;F;9CoBGe1)mIqR)n?WF%-a>5E&dAVye000E8 zNkl(VX&z*aI%$fT*_bywuWJ|VaHmbepfByOuDDsLVC593dFkEi;EvnxlU*e3?jnIZ1i*%fpKB?3@7hNPbCIq0Iid-8Wap&@N;-J(%du}BUuP0Ez^D&@W^(K*CRvp+B3u3_h`B#9% z`k5#&0;ESM)tY2bKbqkYZ45X9ChdbvsO}e^CjW#)aJ~Re6D9_%n^*1i7}UJVx5ZJR zEIJ=Z4cZUt^&bQ8vm3$c#DF=|&(mP2ny?rckL0g|GLtuH2-g4Wqf)AeCB z_0p!pP`Wi9s>7lo|Cs~`*^qYK?~=d*gA5S7{d1G7(w)V5R8GjQPD zDz^t0$zTWHtD**1RdbHoVG0R)ngma?g5rin88u}E+wpP%Sgm$yyYCx27i~I_4eX)K zS#asnFttrr_aOKMWGWA=>C7)wf0M}qPd%Hvs1vv>VEKg&RNsk-Nr;I%Dk@lC{|s2O zF`KHD*Szun9V{W~E0~&^UeIrL)&U=77)8GY1ncYngFf(-oR$Y{>+^Z=*O-m!S6$oU za*CyAeZv@0WdOs0pr?0;>eJrQC+XXXCTZ(YFxHam_dzpk2+ENJ_JXF^b6^*HhQQ%) zEclz1ESGj^3nh6mYh-vGc&VPpPCb`$^=87I%7N42ch3SSgA~~Re_n% z|J$Ebzp=5uA^5pG<$*a1o4O+AVAA>XfHJ{QhP-;_G*EH8S(#v{mewBTQY-PT3T1+A z2{wSqY@t_u$@K7KXs+_WP)YlbF-vb97y6Y6hQeYh%Sy|BP$n3vw~t=8!1~DRiRGRH zJM=!i#C_uHHul*TnF1!RPSFoFhR4Y_`H9P5N544ZKG=~=dQs(E%SFL&1>srN*512d zyV&?LYMWz~&F+IWobF_fa6(|=+9JViPHo+P-+X2c{rIV|=_mKVuu^oDkxFy<-pB;g z>?skohdX)d0;~?4D}+A0B?|@yMwr{Ba804hU^95l02{6JpIZmAg@E=OPNdPz5BmWTJbPuB+ZC Z_79X-XHArjC4T?_002ovPDHLkV1lJ(C-eXS literal 0 HcmV?d00001 diff --git a/Doxyfile b/Doxyfile index 326c6848b5..473aea1d0c 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 b690359abe..e96e2c7d55 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 c062927213..a2ce2f7b68 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