From 3fd3ee90ec6bd97773a59226f21e7d294a6eecdf Mon Sep 17 00:00:00 2001 From: Bastian Kleineidam Date: Wed, 29 Jul 2009 21:53:52 +0200 Subject: [PATCH] Fix GUI documentation install --- MANIFEST.in | 2 +- Makefile | 10 +++------- config/lccollection.qhc | Bin 0 -> 10240 bytes debian/linkchecker-gui.install | 1 + doc/Makefile | 16 ++-------------- doc/html/Makefile | 13 +++++++++++++ doc/html/lccollection.qhc | Bin 0 -> 12288 bytes doc/{ => html}/lccollection.qhcp | 4 ++-- doc/html/lcdoc.qch | Bin 0 -> 28672 bytes doc/{ => html}/lcdoc.qhp | 2 +- linkcheck/gui/__init__.py | 10 ++++++++-- setup.py | 3 ++- 12 files changed, 33 insertions(+), 28 deletions(-) create mode 100644 config/lccollection.qhc create mode 100644 doc/html/Makefile create mode 100644 doc/html/lccollection.qhc rename doc/{ => html}/lccollection.qhcp (81%) create mode 100644 doc/html/lcdoc.qch rename doc/{ => html}/lcdoc.qhp (90%) diff --git a/MANIFEST.in b/MANIFEST.in index a73cac35..0ce4d4d2 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -36,7 +36,7 @@ recursive-include linkcheck/gui/rc Makefile *.png *.qrc recursive-include linkcheck/gui/ui *.ui include po/*.po po/*.pot po/Makefile include doc/*.example -recursive-include doc/html *.ico *.html *.jpg *.png +recursive-include doc/html *.ico *.html *.jpg *.png *.qhp *.qhcp Makefile include doc/po4a.conf doc/*.po doc/*.pot include doc/en/*.1 doc/en/*.5 include doc/de/*.1 doc/de/*.5 diff --git a/Makefile b/Makefile index 8968d9d9..1fc0bfc8 100644 --- a/Makefile +++ b/Makefile @@ -18,21 +18,20 @@ DEB_ORIG_TARGET=$(BUILDDIR)/linkchecker_$(VERSION).orig.tar.gz .PHONY: all all: - @echo "Read the file doc/source/install.txt to see how to build and install this package." + @echo "Read the file INSTALL.txt to see how to build and install this package." .PHONY: clean clean: -$(PYTHON) setup.py clean --all rm -f linkchecker-out.* *-stamp* $(MAKE) -C po clean - $(MAKE) -C doc clean + $(MAKE) -C doc/html clean $(MAKE) -C linkcheck/HtmlParser clean rm -f linkcheck/network/_network.so find . -name '*.py[co]' -exec rm -f {} \; .PHONY: distclean distclean: clean cleandeb - $(MAKE) -C doc clean rm -rf build linkchecker.egg-info rm -f _LinkChecker_configdata.py MANIFEST Packages.gz # clean aborted dist builds and -out files @@ -56,6 +55,7 @@ locale: # to build in the current directory .PHONY: localbuild localbuild: MANIFEST + $(MAKE) -C doc/html $(MAKE) -C linkcheck/HtmlParser $(PYTHON) setup.py build cp -f build/lib.linux-$(MACHINE)-$(PYVER)/linkcheck/HtmlParser/htmlsax.so linkcheck/HtmlParser @@ -79,10 +79,6 @@ release: distclean releasecheck dist-stamp sign_distfiles homepage upload @echo "Register at Python Package Index..." $(PYTHON) setup.py register -.PHONY: homepage -homepage: - $(MAKE) -C doc homepage - .PHONY: chmod chmod: -chmod -R a+rX,u+w,go-w -- * diff --git a/config/lccollection.qhc b/config/lccollection.qhc new file mode 100644 index 0000000000000000000000000000000000000000..8970f4c6e58ab994a69827bd9f40b1c79bc53c8d GIT binary patch literal 10240 zcmeHMK~K~`7=6=rshVtz|DZjXsOZ5M55xm5WR(U)T+qk?H@mV*lZ92N2_D;D?465m zN;aLuc7ma#6uu@qGo6|5oA15p*KX!*f7pnVN$_oUd^k#i7x17IUIzhy1^&!S-z%fT zG1}HK%cI5SOzS6Siwf#zUWc`9wEX$ts`vae%{i4!22zh5#G_~0K2?jXa6pqvbD)T z4+%oA*vDs<0UjeAJASydq_U4D;28n$=YUOkWxcKqOqs!DLO;O|g80h7%D`Jd9w*F>ba5e8bwfX;tcEki9kPu%wJNy7U7KDmugY{x&9G17Gb)w;D^1Q z$~uKAv`uYED||7I@Es=<$>u6x^~l|7MX1_H>p|;W?6;xc*wnjE3}i~lQR{bFEqu>X zf5oT1AEw=&$|Kg2-6^B~$*FO!P7Z0Nb;_ABK16j`Lp-;P-s4_*>6Yh*QKYg51#PBo zIak37>g=PPYWnPk^+;;@U!k?mxd`p48e!lsgp-#Y literal 0 HcmV?d00001 diff --git a/debian/linkchecker-gui.install b/debian/linkchecker-gui.install index 311bc366..19fa2eef 100644 --- a/debian/linkchecker-gui.install +++ b/debian/linkchecker-gui.install @@ -3,3 +3,4 @@ usr/lib/python2.5/site-packages/linkcheck/gui usr/share/man/man1/linkchecker-gui.1 usr/share/man/de/man1/linkchecker-gui.1 usr/share/linkchecker/lccollection.qhc +usr/share/linkchecker/lcdoc.qch diff --git a/doc/Makefile b/doc/Makefile index 5ea27704..b6ddaf04 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,24 +1,12 @@ -HELPFILES = lccollection.qhc - -all: $(HELPFILES) - -clean: - -rm -f *.qhc *.qch +all: test: xmllint --valid --noout *.html - -%.qhc: %.qhcp lcdoc.qhp - qcollectiongenerator $< -o $@ - po4a: po4a --localized-charset=UTF-8 po4a.conf api: epydoc --html -o api --name "LinkChecker source documentation" --url ../index.html ../linkcheck/ -.PHONY: po4a api clean -favicon.ico: favicon32x32.png favicon16x16.png - png2ico favicon.ico favicon32x32.png favicon16x16.png - +.PHONY: po4a api test diff --git a/doc/html/Makefile b/doc/html/Makefile new file mode 100644 index 00000000..bddf2d01 --- /dev/null +++ b/doc/html/Makefile @@ -0,0 +1,13 @@ +HELPFILES = lccollection.qhc + +all: $(HELPFILES) + +.PHONY: clean +clean: + -rm -f *.qhc *.qch + +%.qhc: %.qhcp lcdoc.qhp + qcollectiongenerator $< -o $@ + +favicon.ico: favicon32x32.png favicon16x16.png + png2ico favicon.ico favicon32x32.png favicon16x16.png diff --git a/doc/html/lccollection.qhc b/doc/html/lccollection.qhc new file mode 100644 index 0000000000000000000000000000000000000000..3a30308734589c9327adbc6797c1ed7ac94c3d09 GIT binary patch literal 12288 zcmeHN3s_S}7M^=25Z)rbDngr}$io8VA%X=ZkO+}i1Qbyz1c(@jgr`bB1cLo2S|4on zQ%Y?sk9MhFTeT||P}_=B5n1ahE^Yl#S#;fX5ww66adFQCF`*4v`qh4|<=!N7=XK7U zb7sz&oB40}k|1fOgtJ(u86zqVtq}>#v=|oP8nyXENEaJ}zfrgz z!I!xh3osUV<}Bbvu~3wA99oT%kt6tcDtsIv9!pUQ)Wn0wOCU{FMrRr15|A8HN0g>) z8}k1ignOPj#TkJa3osV=`4%vQfI&^ChT;J6e|YF;F2(|k1;(KT82=xKlg_BjSm3b* zi2q}1A)*%2_ILtzfWHgB*2Pl%@s3sgfGTM^DH=Z~f8*^um)ZY+t#HTiWi0Ufw}3JI z3Sv=n5FLl-Qgf&~zki8;GYJ*Gx@<0wM-}L(P@!-*RwW1@Ic!Zt832+EqkyBg=#P#F zjZQ@Hpg^6YZY0Bebf>_1? z8Nn&#YV9#-bg^QPvzAr^m@Ae-#A0)WLaJb*%53VmEYRX5U z0G%Nal&e`K&8nzs*<({dMLS!g`G7~5mnT%c_TbPx6*s*DB7N;sB6EO zpD_bJMGL&3kGbx3SWk3q7baB>*?tCTgl%*Uv1-Poj35Gmjn+Rm-fMX4_ z@YKQ5C!(n@??oU`3cy#x`Vaysl(L@)yO4#`MvOi-a@E-07z>1cAj%Mc#s~hyhGa}R z3K;an#^cg@A4sCL@9%LpUJW-RxTmr^RK=M>HANV*u z=I97Lv_W`Ij{!U<<+wu;+z~isf?;LIiNc7FDf#J^v)d97xU(AaL}@-r9$&s6 z<`^&~)i+>i+RXBZ^IrSi8V_}RcgRwH>`GsJ>%fD19lPwSGD=T2@6GjlF5YAR-ln+L z&sX->*j~D-r~h4vxTNxL*4AH5&7HUSTS0062bpf6+f8!r_MABS@`T8|lDzE0d4nys zCT@nwQPZt08(WQJa_^LdxyAj>xi$AMiv2y@?uOoqH0$lUuH zY`NCAu08(4)S|h0*DuI*+By$h#fXhgFIY9*gx&vD&w+EC1#jk;hucmSiSpx4pK1^} zomlsG+r;=?I?}$(;{Haju5NVu$QyBA z`u^qPijV&F(iF?h*NYOJrade*`Z{`AZ(;ATif*SCLy4FDyRYq;Caz_j{BOS9OJ4Tw z2amP!1OHQBZD(5@8#d|ghR(R!u#HPZ_U}*bZt;I--?TY1jut0OatfZnoig*ziunfB zCP{5m-GWaV;;FO$9OtvCe3|J3{nIu&`y;%!p7Dz31yq|=eo*LBwCO4rWtdL1yq>Q6 z(Q3TY#%e=%v+ZDwjlxB@zF+70_A?$veOd2T@XWT9e|CVq@`ig8+j5o1^b_?m7VRot zZ@%xZ=FQu;w&hH${ZzKbJ;m_i%`3aE-@dv#ddJP%fr;hI_c%0q8qYF4)f;PYAV^TQ z*ld~WK+Vz56%S`q89`NbeLDVo5)U!+#gH&2>jek1n5>;;L*pSgqzgJNoO-(J_${a$H^-(>d0$&&)M8r7e5K784s z^PfFcy8^$-Dc{$$?NNQ##=djm#pv4Rxj(GseL64F<%cEvzd6`8OSdqj<9>@p-C&f+ zrLeGFVOG*OGp+0Fqq3j{ji&c294bG#^5)^b)}1o1hwYNyYoR5_vyZqX zd-p8ry0!cDGb>n>IlG;|Jfv8($2loEwvsxPbf?JvsB4GCx LinkChecker - html/favicon16x16.png + favicon16x16.png bfk/LinkChecker - qthelp://bfk.app.linkchecker/doc/html/index.html + qthelp://bfk.app.linkchecker/doc/index.html false false false diff --git a/doc/html/lcdoc.qch b/doc/html/lcdoc.qch new file mode 100644 index 0000000000000000000000000000000000000000..36e456db25b356384693b88d7a3ee5022dc109a9 GIT binary patch literal 28672 zcmeHP2|QF^-@h}1QL=B@G9p_D5h2+syBPbHHT%AX5|WURXtPxI?6Q-RC6VlkWG7jo ztR;Hy@OVc5M*n)=_w#)IZ_PDx+_`7D=leb9+~xcGor6?Wv~o2^oOW=wGj>HB1aJTd z1du==005u`zgssl@CRhe0qB=ci~$qC7BB~n16JUFS8&f6Q2(2wxYB?ca14+H6CMK)U?>Sl0gCJUn2SLG?0_;@ zs2y0m9AF0Kkpq9Da-RUdY5*5_WNS`Iup+KtMXbQexvf_UQ!WI+0r;JS!I|XbApWG7 zp=_QNGobU>gAAY`3&$eX30C_DyegW)P3i$-xZnN9kZc2lGco{2v0Ag}|AP9fSDqKm*>S#szQ$`;95sZ_prr6bIcN z*pIUPIv8cth$15f1HxTkfR7Iba2!G~guprh@Ppm33}6}f9T?z%zyKW+;51+Z@PHR1 zNAQmayjNNQ_TUjyz!JPTnSy($J11)VgExKbhGhWDz#qr}cKrW=jgEzkW#C^7V8=hU zD_|M;a~Z&n|3A0wvB z+up>1DfzFPHW2@|)uG24%0h=SZ<&LYbOoi))8H2+cz&DWdlL&LlNj3Cx4kt`5!xoNFhsR2_W2*<^$vRw%fKJO z0CxQU5zUMRiDdvI1E}#2fyDyg2fJYzz%uX;V!#A~3qbs2Apfco#kvE}#tSzO_@?O! zdZ*fgabln+s}=Z$VgpEjxq$y%LHcV2F^Mhfl9|s=IFqsQHW#b7(k7G zC`=vz=jF-&E|{=5unhe78MsRe#Q~lO1AxH1XKbyWoeN#D`A=;*_ydWOhrqby-| zax{8HIng~KHXLqk2N)cwSxBd$bU@?v-gmw;E=0K_SMQnLo>#Q6B`hU~T@o6gk6&#J zO*r7->%F9=D6J9V@kq?q#f`&jb#S&iv2k#=cADVBVSb;z0xzxs`P76BUx-e=)w6T)Q7H#-A*hM!7U7OPPLi9r3@)EUt*w~wLN z9_sd)(7heSJG%OsC}SUJ@8*w02>4Y?1p6k%fLT~0ZAzAh>kS)tY{A2zEQJSP%{xWo*~Quet;MJI}C7xp%57I zgZt`W$Oni32f;s7$O|w)V1hJG>r+!S!D5`(UlUNp@PTUr@uIL&UAX5FX>M`ZMK!uE zVdnhY?1$l}PNGxqhrm^F?_G_~nuO?|hhxlDRf+)=tZb0>l$ zWXjQRk1)n0e?%rrsVK(L4$B?sJgxf5C&Ig*93rq!ZFyz(phQQb94^t9w^H~;b^P~c zDwgn6Zc>lxI#!HcZncG#*SiXmex+cZ+&LP5DJpfy_rU|EoWLvR&0p6&w2r-xP?;DtBmMf3u>s#6db zsV$^~zuvW!RAw}Er8?gj^iFV191d z)oa1mld^Z{4s`D=-(S)2%*soO`t8G5%jsgOo}j?R#K6UFDM)b1=OhMGC3j7aQtBQ8 zjymOZQ-}^*Z$yc6!-%}Z&4wx$J?{zO$r^#FtmGHb9~y|++`5l4#O}H`yf*xXj;um9 zhu}lwijWCjHM?1^z2l+GD9Py|50-~7R>H26*H*+CilwsoC!7yQjtzJ1q}nBn7)Y)} zwm6PY>>Y0##=QX$Q(IKVq?|Pnef)kF$(>rHCP>1oH;co?>Vi)#1t+`4UvyLPSnf?- z_Qz``wn-N&1V!-YG*ZXS8fqJ^P3yRT= zex7)M?Vfu@JvhSFr*99q-L(`tUzD4KoaIR{BMQ8FHc!e;oAvDR>z~qe2T5P4bJXne zAB?i^FAQh4e5A(Pir3`D7k#kiKTlTJSE(=|+Vgb2oYk!&d~TVLgm`ah3w>k8XuG298J46SnJ@5DdiDz`@Q10` z(4^30s7U6JBuifj($yeM9#g+-K%sZ7^HmHs@*h25i`qn2Cj42vfi23^1g&`~Bl}z4+9y}$m9mtu6INSyH0Ah%k3$9&XWQqyh2yV zMd-8rA4Qm+wI1}EYwEB3y2yc0mL<<3>(lmTyLGF$a#f?Eq>?GHN_17?{LJCV5L&Vr ziJak#;Y{~>8Gw=dE{x}DTH<4}V_bph3ubg@vaS0(=cwM75IqRsdVjfbjP{G-!UZm> zG!pm|wcN;DehGpsg%+`D5mq&Fo&8Iv+T93J&tD~Np7*>dbE8A5WW37vq3;46`+XAa zkeH=lLYhmp5UcEg7*cWW(-OC&G@#N<1b)vi+l9JWHa;p?)beJ#_(9W9TStVZk9I1S zGoYD2Gb!j0d|7uiQj~1&Rv<~>rJg;Vb@KLn7m#Ka-ZqJ%okuD3>+(6I>vBk=D zKtZPMuu!{^wlvin+x!Erie&0kE4-ac`UA4_lnrcDFyoEzPNwMok4)_t4=^>8AD)gA?0wL(`su>w~pS7 zM*hhRsUbn4!VizjMc4}EZt^$Rj31SgNMyAgSmf(c$JeY^q=5i1a6EtALM+h5WuYSQrNiBGbZtZDHV~!I$a_^CIO!()FHTHx*=eevU)SN>z z19XbZySJ+|kA4YQb(aDh|GT@QIRz>>25?R> zoPR=fzlW6c)2B6~rW02wD)1M^3>4+WPp4PEsqZ4|L|V<2ODs+5b>%L&`wA4kF&`Zo zXJAnA-4p)KB)QO<&)XH)%aW*jxIA!r+`y~PDTVG8-|YMF#!t!5Jaz*|zwRt^s+ze> z$opC?f|89q<#l9r-Y51eb{9^(J4_^$CoBq7KMd`u4^Is}P)i*S2VRzQKW9!mNtzx; zB+?ZX)VMRXEUtc5zY}Rg#Cw01RJ_E6dst&dJ9zth)E>C$OPbUv^1;UM*Al}C@HURhkAyJ9x!Ic>C@UBK6Im#{+wnf*{{ zI@gJ^t7EVKNaUTxo_$4g>4~r9BWk8>b%ypuCQKhYhtu!S%hOP7_NDKN?d;GfG^S~< zA*HTjaT1Y;yNHaLy|7AL;y*(S#~Ml@YYm8P0a zGtV<-o9gH6K3rGP9&pU25+MKRpeHntz;}RmOhG<`_v|~SeDPB{YEueKi=Ebf1GpxI zMwBkiC#Q7|mM%B5-4k8%w@$Hip2$t&K~^kf#0VU%o;FmAei+&nlTCI}>p&2F=f!|3 zMEOU)S9|LO$;pi1YvBU2wVqnkw^VA%)vA_|x9zRyil2-kSAyF((=Q9uLaO^#Z>$b= zp6jDcy=X~q5md^Eyz}h!Ioh;A87MM{ukAvh0oQ|1>eYNvX=3E9?jsX+gNAoAQ^W*S zjTKVz>~`aZNJ#8UHtE7Ezu;<`vAFkE%x!b;PsUF>3XAcnT6A-%dQmR`jJ0Pdo*7r= zRg2fZk`=wLExLzhp2wUoTKOYk{&Q=+2_Lz>XWZI?_mfhM@m}sG7rlQ!E>Abu?ns{` zVe?u4cHXN;@k4X(X1*FXK2mdoq;od#fi9`A(HwoN7~@`|kBOCZZ>@}Mlz`DI6!Sh3 zV%M|psAe1J`i3E76Jc5%`5ZzQ%J}1Pm*{A7+(l~Zs1)3wDwp?;9)C1ucI>1{mQk7% zzn5g!3M3B~`s~_GtMkdF<))HOAuKYzUx`hRjx|@V^4lkbzNoZijZ2A*yR|^y$Z;;) zUgKWxaGgNe)t-Tf$l)`Igo)mT%F|1y-=r<+x9!t-WO$K-^0Ec5f9NBROMNF3Qr~fV ziAcoFjkH#`GkSIRLmn3KxGna`K;yO>oqbp(uXflYRK5i6@M70H1Q2^C~(meh>WIvls^)zPk*((D!cX4$55ZJ2nN)SaERqs2EpV{TQcu6 zX7jxhAuVo1ns}~EPLT8dFiFojEzV%}f@3kByLpHVy7~7_H-}U2Np(uRZT%Sz5ACZ} z@|w-t?O4bJ{WUUO9AdwRCnR>LkB zFHyc@SsZPKjb*%bR(9LoHFw!D=GC&slC<_qimnAmbYf4l(iR<))e7tA9FXr(dgd>* z@;H!(t5S`!fjjBko|}_x$I{zW+I7qFOS_XwUahIqoV6<*VYd~9HFcj?hW4a~ zg`O+5ZY=0@Kdui@GFxl7a-;6NFa#OYLXC0ZPAi@u=*$3k8u|0kFv{hxV$o?`$QH7^eqfb6RCGQ_8G8Cu0 zzC2k{=;7u3aamjJgh6)IGv90Sbjbudgopg%3EO8hm#<4ucYlT8SJSQSL|p)|>;Ixy zz;0Lu{x}9u;~xqeLizs={c+&2fUykx_6+QX31apj!hsP&ARFU<9)Nv@&HwgPU;$zo zz%l^f!XOYR6cs`?{Qsbg0F)7$4b#DrgJs|w2K;uBz?t|!FH}LaZ|9~%AleBNy@&Q| zqxsf*ZL2ru_XTWvabhY6?a>DMZ~i}WHDw_K9UUbhn7m?9PLpV;o350bw4gbp+n&SC XOy3r@$>V11_eE|low%`(B?s_7byFSA literal 0 HcmV?d00001 diff --git a/doc/lcdoc.qhp b/doc/html/lcdoc.qhp similarity index 90% rename from doc/lcdoc.qhp rename to doc/html/lcdoc.qhp index 330c5f1f..5f0d5504 100644 --- a/doc/lcdoc.qhp +++ b/doc/html/lcdoc.qhp @@ -7,7 +7,7 @@
- html/index.html + index.html diff --git a/linkcheck/gui/__init__.py b/linkcheck/gui/__init__.py index cfe89bf0..075ed9c2 100644 --- a/linkcheck/gui/__init__.py +++ b/linkcheck/gui/__init__.py @@ -30,7 +30,7 @@ from .. import configuration, checker, director, add_intern_pattern, \ from ..containers import enum -DocBaseUrl = "qthelp://bfk.app.linkchecker/doc/html/" +DocBaseUrl = "qthelp://bfk.app.linkchecker/doc/" Status = enum('idle', 'checking') @@ -51,7 +51,13 @@ class LinkCheckerMain (QtGui.QMainWindow, Ui_MainWindow): self.checker = CheckerThread() self.contextmenu = ContextMenu(parent=self) # Note: we can't use QT assistant here because of the .exe packaging - qhcpath = os.path.join(configuration.configdata.install_data, "doc", "lccollection.qhc") + path = configuration.configdata.install_data + # here lies the help file when developing + qhcpath = os.path.join(path, "doc", "html", "lccollection.qhc") + if not os.path.isfile(qhcpath): + # here lies the help file after installing as a package + path = configuration.configdata.config_dir + qhcpath = os.path.join(path, "lccollection.qhc") self.assistant = HelpWindow(self, qhcpath) # setup this widget self.init_treewidget() diff --git a/setup.py b/setup.py index d2a6cdfa..de0c5631 100755 --- a/setup.py +++ b/setup.py @@ -369,7 +369,8 @@ myemail = "calvin@users.sourceforge.net" data_files = [ ('share/linkchecker', - ['config/linkcheckerrc', 'config/logging.conf', 'doc/lccollection.qhc', ]), + ['config/linkcheckerrc', 'config/logging.conf', + 'doc/html/lccollection.qhc', 'doc/html/lcdoc.qch']), ('share/linkchecker/examples', ['cgi-bin/lconline/leer.html.en', 'cgi-bin/lconline/leer.html.de',