A.3 Tools: automatic generation of documentation

 

The most powerful feature of ProTeX is the possibility for automatic generation of nearly-publishable quality documentation with the help of perl, LaTeX and latex2html, which have to be pre-installed on a given platform.

• LaTeX source can be generated with

  protex source.f > source.tex

• PostScript documentation can be generated from the LaTeX source with

  latex source.tex
  dvips source.dvi > source.ps

  or with similar commands.
• HTML documentation can be generated from the LaTeX source with

  latex2html source.tex.

This procedure can be embedded in makefiles so as to provide finished documentation on request when software is built. The following is one example of how to write such a makefile.

#
RM    =  rm -f
CAT   =  cat

PROTEX=  protex -s
LATEX =  latex
DVIPS =  dvips
LATEX2HTML =  latex2html

DOC=      geos_init_lib
DOC_TEST= geos_init_test
DOC_SRC= ParUtilities_types.f ParUtilities_module.f \
         Grid_types.f Grid_module.f ParRestartIO_module.f

DOC_SRC_TEST= ParUtilities_test.f Grid_test.f ParRestartIO_test.f 

doc:		doclib doctest

doclib:
	$(CAT) INTRODUCTION $(DOC_SRC) > $(DOC).f
	$(PROTEX) $(DOC).f > $(DOC).tex
	$(RM) $(DOC).f
	$(LATEX) $(DOC)
	$(DVIPS) $(DOC)
	$(LATEX2HTML) $(DOC)

doctest:
	$(CAT) INTRODUCTION_TEST $(DOC_SRC_TEST) > $(DOC_TEST).f
	$(PROTEX) $(DOC_TEST).f > $(DOC_TEST).tex
	$(RM) $(DOC_TEST).f
	$(LATEX) $(DOC_TEST)
	$(DVIPS) $(DOC_TEST)
	$(LATEX2HTML) $(DOC_TEST)