install_doc_LUKE

LUKE - Installation script for automatic generation of the on-line documentation 

Installation script for automatic generation of the on-line documentation using MatHelp library

 INPUT:

    - verbose: display the output of the documentation build-up (on/off). Empty is off.

 OUTPUT: none

By Yves Peysson (CEA/DSM/IRFM, yves.peysson@cea.fr) and Joan Decker (CEA/DSM/IRFM, joan.decker@cea.fr)

0001 function install_doc_LUKE(verbose)
0002 %LUKE - Installation script for automatic generation of the on-line documentation
0003 %
0004 %Installation script for automatic generation of the on-line documentation using MatHelp library
0005 %
0006 % INPUT:
0007 %
0008 %    - verbose: display the output of the documentation build-up (on/off). Empty is off.
0009 %
0010 % OUTPUT: none
0011 %
0012 %By Yves Peysson (CEA/DSM/IRFM, yves.peysson@cea.fr) and Joan Decker (CEA/DSM/IRFM, joan.decker@cea.fr)
0013 %
0014 if nargin == 0,
0015     verbose = 'off';
0016 end
0017 %
0018 pathmetis0 = which('metis4itm');%remove metis4itm in the Matlab search because it uses also m2html nut in a different way
0019 if length(pathmetis0) > 0,
0020     imetis4itm = strfind(pathmetis0,'metis4itm');
0021     warning off
0022     rmpath(genpath([pathmetis0(1:imetis4itm(1)-1),'metis4itm']));
0023     warning on
0024 end
0025 %
0026 excludedfoldernames = {'EAST','HL2A','AMR'};%list of excluded folders. Update if necessary
0027 %
0028 disp('************************* EXCLUDED FOLDER NAMES **************************')
0029 for ie = 1:length(excludedfoldernames),
0030     disp([' - ',excludedfoldernames{ie}])
0031 end
0032 disp('**************************************************************************')
0033 %
0034 dirinit = pwd;
0035 %
0036 dkepath = load_structures_yp('dkepath','','');
0037 luke_root = dkepath.luke_root;
0038 %
0039 helptools = '';
0040 %
0041 if isfield(dkepath,'latex') && isfield(dkepath.latex,'env') && ~isempty(dkepath.latex.env),
0042     helptools.htlatex = dkepath.latex.env;
0043     helptools.pdflatex = dkepath.latex.env;
0044 end
0045 %
0046 if isfield(dkepath,'imagemagick') && isfield(dkepath.imagemagick,'env') && ~isempty(dkepath.imagemagick.env),
0047     helptools.imagemagick = dkepath.imagemagick.env;
0048 end
0049 %
0050 if isfield(dkepath,'graphviz') && isfield(dkepath.graphviz,'env') && ~isempty(dkepath.graphviz.env),
0051     helptools.graphviz = dkepath.graphviz.env;
0052 end
0053 %
0054 % List of pdf text files that can be viewed from the web browser.
0055 %
0056 % Format:
0057 %       texfilelist(i).file = path to the file without extension;
0058 %       texfilelist(i).title = name of the link in the webpage;
0059 %
0060 texfilelist(1).file = 'Project_DKE/Doc/NoticeDKE';texfilelist(1).title = '3-D linearized relativistic bounce-averaged electron drift kinetic solver (LUKE)';
0061 texfilelist(2).file = 'Project_DKE/Modules/C3PO/Doc/raytracing';texfilelist(2).title = 'Universal multi-wave ray-tracing (C3PO)';
0062 texfilelist(3).file = 'Project_DKE/Modules/FEB/Doc/3Tmodel';texfilelist(3).title = 'Fast electron bremsstrahlung (R5-X2)';
0063 %
0064 redminepath = 'https://spcsrv18.epfl.ch/redmine';%path to the redmine website
0065 %
0066 if isempty(redminepath),disp('WARNING: the ''redminepath'' path is empty.');end
0067 %
0068 make_help(verbose,luke_root,redminepath,texfilelist,excludedfoldernames,helptools);
0069 %
0070 cd(dirinit);