[petsc-dev] generating html pages

Stefano Zampini s.zampini at cineca.it
Fri Aug 9 11:29:50 CDT 2013


Thanks


2013/8/9 Satish Balay <balay at mcs.anl.gov>

> Note: doc generation has sequential dependencies - so to do 'make
> manualpages LOC=$PETSC_DIR' in any given source tree - make sure the
> previous seteps are done atleast once.
>
> i.e
>
> cd PETSC_DIR
> make alldoc1 LOC=$PETSC_DIR
> cd src/ksp/ksp/interface
> make manualpages LOC=$PETSC_DIR
>
> Satish
>
> >>>>>>
> alldoc: alldoc1 alldoc2 alldoc3 docsetdate
>
> # Build everything that goes into 'doc' dir except html sources
> alldoc1: chk_loc deletemanualpages chk_concepts_dir
>         -${PYTHON} bin/maint/countpetsccits.py
>         -${OMAKE} ACTION=manualpages_buildcite tree_basic LOC=${LOC}
>         - at sed -e s%man+../%man+manualpages/%
> ${LOC}/docs/manualpages/manualpages.cit > ${LOC}/docs/manualpages/htmlmap
>         - at cat ${PETSC_DIR}/src/docs/mpi.www.index >>
> ${LOC}/docs/manualpages/htmlmap
>         -cd src/docs/tex/manual; ${OMAKE} manual.pdf LOC=${LOC}
>         -cd src/docs/tex/manual; ${OMAKE} developers.pdf LOC=${LOC}
>         -${OMAKE} ACTION=manualpages tree_basic LOC=${LOC}
>         -${PYTHON} bin/maint/wwwindex.py ${PETSC_DIR} ${LOC}
>         -${OMAKE} ACTION=manexamples tree_basic LOC=${LOC}
>         -${OMAKE} manconcepts LOC=${LOC}
>         -${OMAKE} ACTION=getexlist tree_basic LOC=${LOC}
>         -${OMAKE} ACTION=exampleconcepts tree_basic LOC=${LOC}
>         -${PYTHON} bin/maint/helpindex.py ${PETSC_DIR} ${LOC}
>
> # Builds .html versions of the source
> # html overwrites some stuff created by update-docs - hence this is done
> later.
> alldoc2: chk_loc
>         -${OMAKE} ACTION=html PETSC_DIR=${PETSC_DIR} alltree LOC=${LOC}
>         -${PYTHON} bin/maint/update-docs.py ${PETSC_DIR} ${LOC}
> #
> # Builds HTML versions of Matlab scripts
> alldoc3: chk_loc
>         if  [ "${MATLAB_COMMAND}" != "" ]; then\
>           export MATLABPATH=${MATLABPATH}:${PETSC_DIR}/bin/matlab; \
>           cd ${PETSC_DIR}/bin/matlab; ${MATLAB_COMMAND} -nodisplay
> -nodesktop -r "generatehtml;exit" ; \
>           cd classes; ${MATLAB_COMMAND} -nodisplay -nodesktop -r
> "generatehtml;exit" ; \
>           cd examples/tutorials; ${MATLAB_COMMAND} -nodisplay -nodesktop
> -r "generatehtml;exit" ; \
>         fi
> <<<<<<<
>
> On Fri, 9 Aug 2013, Barry Smith wrote:
>
> >
> >    In the directory in question run make manualpages  with LOC set
> appropriately.
> >
> >    Barry
> >
> > On Aug 9, 2013, at 10:17 AM, Stefano Zampini <s.zampini at cineca.it>
> wrote:
> >
> > > I'm currently creating manual pages for PCBDDC.
> > >
> > > To obtain the html, I currently run make alldoc, which takes 40
> minutes on my laptop, rebuilding everything from scratch.
> > > Is there a faster way to produce manual pages for a single directory?
> > >
> > > --
> > > Ph. D. Stefano Zampini
> > > CINECA
> > > SuperComputing Applications and Innovations Department - SCAI
> > > Via dei Tizii, 6 00185 Roma - ITALY
> > >
> ------------------------------------------------------------------------------------------------------------------------
> > > Email:
> > > s.zampini at cineca.it
> > >
> > > SkypeID: stefano.zampini
> > > GoogleTalk:
> > > stefano.zampini at gmail.com
> > >
> > > Tel:
> > > +39 06.44486.707
> > >
> ------------------------------------------------------------------------------------------------------------------------
> > >
> > >
> >
> >
>
>


-- 

Ph. D. Stefano Zampini
CINECA
SuperComputing Applications and Innovations Department - SCAI
Via dei Tizii, 6 00185 Roma - ITALY
------------------------------------------------------------------------------------------------------------------------
Email: s.zampini at cineca.it
SkypeID: stefano.zampini
GoogleTalk: stefano.zampini at gmail.com
Tel: +39 06.44486.707
------------------------------------------------------------------------------------------------------------------------
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mcs.anl.gov/pipermail/petsc-dev/attachments/20130809/f08c1bbf/attachment.html>


More information about the petsc-dev mailing list