[Q-e-developers] Problem with making the Docs with dev-tools/helpdoc

[Hsin-Yu Ko]

Dear Oliviero and Tone,

Thank you so much. Tone is right, I am using tar.gz version 5.0.2.
The CP/Doc builds after following Oliviero's suggestion:
  1. make gui   (getting the PWgui package)
  2. replace the second line of helpdoc.d/helpdoc.tcl file with
Oliviero's patch.


Best,
Hsin-Yu

On 09/03/2014 04:19 AM, Oliviero Andreussi wrote:
> Dear Hsin-Yu,
>
> Are you trying to make the documentation of which version of QE, the svn or the 5.1? In the two cases the tclu library is in different places, namely in
>
> espresso-svn/GUI/Guib/lib/
> espresso-5.1/PWgui-5.1/lib/Guib-0.5.1/lib/  (in this case you would need to download also the PWGui package)
>
> I used to have the same problem when trying to make the doc in the released version of QE, as the default strategy is to have not-compiled documentation in the svn, while having only the compiled versions in the release. This was changed recently, and from the next releases it should be possible to compile the documentation also from the release. In the meatime, you could modify the helpdoc file as suggested to me by Tone Kokalj, namely
>
> In the helpdoc.d/helpdoc.tcl file replace the second line:
>
> lappend auto_path $dir [file join $dir .. .. GUI Guib lib]
>
> with:
>
> # do we use the svn version
>
> set libdir [file join $dir .. .. GUI Guib lib]
> #
> if { [file isdirectory $libdir] } {
>      lappend auto_path $dir $libdir
>
> } else {
>      # do we use the tarball version
>
>      set libdir [glob -nocomplain -directory [file join $dir .. ..] [file join PWgui-* lib Guib-* lib]]
>      #
>      if { $libdir != {} && [file isdirectory $libdir] } {
>          lappend auto_path $dir $libdir
>
>      } else {
>         puts stderr "no usable directory containing the tclu library found; you need to download the PWgui package"
>         exit 1
>      }
> }
>
> Best,
>
> Oliviero
>
> On 09/02/2014 11:05 PM, Hsin-Yu Ko wrote:
> Dear QE developers,
>
> While trying to make some update in the CPV/Doc, I found that the tclu package undefined.
> After some search I found it hard to identify which package tclu comes with; hence, I was wondering if I could ask some help from here?
>
> The following is the command I was used to make the documentation of CP:
>
> ----------shell input/output--------------------
> # inside CPV/Doc
> $ make INPUT_CP.html
> ../../dev-tools/helpdoc INPUT_CP.def
> can't find package tclu 0.9
>     while executing                                                                                                                                                                  &n! bsp;
> "package require tclu 0.9"
>     (file "/home/hyk/Hosts/Teller.git/QE-dev/dev-tools/helpdoc.d/helpdoc.tcl" line 4)
>     invoked from within
> "source [file join $sourcedir helpdoc.tcl]"
>     (file "../../dev-tools/helpdoc" line 8)
> make: *** [INPUT_CP.html] Error 1
> ------------------------------------------------------
>
>
> Following the dev-tools/README.helpdoc, I checked the following packages (tcl-8.5.15, tcllib-1.15, and xsltproc*) are installed.
>
> *------ xsltproc --version ----
> Using libxml 20901, libxslt 10128 and libexslt 817
> xsltproc was compiled against libxml 20901, libxslt 10128 and libexslt 817
> libxslt 10128 was compiled against libxml 20901
> libexslt 817 was compiled against libxml 20901
> ---------------------------------------
>
>
> Thanks a million,
> Hsin-Yu
>
> --
> Hsin-Yu Ko
> Graduate Student
> Princeton University
> Department of Chemistry
> 151 Frick Laboratory
>
>
>
> _______________________________________________
> Q-e-developers mailing list
> Q-e-developers at qe-forge.org<mailto:Q-e-developers at qe-forge.org>
> http://qe-forge.org/mailman/listinfo/q-e-developers
>
>
>


-- 
Hsin-Yu Ko
Graduate Student
Princeton University
Department of Chemistry
151 Frick Laboratory