Documentation: move PDF creation from Makefile to new script 'make_pdf'.

The new script make_pdf can be used in the Makefile and in the CMake
PDF generation process. CMake update will follow in a later step.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10702 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Albrecht Schlosser 2015-04-13 20:33:46 +00:00
parent 43b57ef526
commit 0663c45e9c
2 changed files with 65 additions and 29 deletions

View File

@ -1,9 +1,9 @@
#
# "$Id$"
#
# Documentation makefile for the Fast Light Tool Kit (FLTK).
# Makefile for the Fast Light Tool Kit (FLTK) documentation.
#
# Copyright 1998-2010 by Bill Spitzak and others.
# Copyright 1998-2015 by Bill Spitzak and others.
#
# This library is free software. Distribution and use rights are outlined in
# the file "COPYING" which should have been included with this file. If this
@ -56,12 +56,15 @@ MANPAGES = $(SRC_DOCDIR)/fltk.$(CAT3EXT) $(SRC_DOCDIR)/fltk-config.$(CAT1EXT) \
all: $(MANPAGES)
# use make dist to create all docs for distribution files
# you need an installed version of doxygen for this
dist: all html pdf
# Use `make docs' to create all docs for distribution files.
# You need installed versions of Doxygen and LaTeX for this.
# synonym for dist
alldocs: dist
docs: all html pdf
# Synonyms for docs:
alldocs: docs
dist: docs
clean:
$(RM) fltk.pdf refman.pdf src/fltk-book.tex
@ -123,10 +126,10 @@ uninstall-linux uninstall-osx:
$(RM) $(DESTDIR)$(mandir)/man6/checkers.6
$(RM) $(DESTDIR)$(mandir)/man6/sudoku.6
# The HTML files are now generated using doxygen, and this needs
# The HTML files are generated using doxygen, and this needs
# an installed doxygen version and may take some time, so this target
# is not made by default.
# Use `make html' or `make dist' to create the html docs
# Use `make html' or `make docs' to create the html docs.
html: $(HTMLFILES) Doxyfile src/fltk-book.tex
echo "Generating HTML documentation..."
@ -138,12 +141,10 @@ html: $(HTMLFILES) Doxyfile src/fltk-book.tex
fi
test -d html && cp src/tiny.png html/
# this is only used to minimize subversion updates of the online docs
html-online: html
echo "*** Warning: re-create HTML files if you want to build distribution files."
echo "*** Warning: Use 'make html' to re-create the correct HTML files."
echo "Stripping HTML files for online documentation upload..."
./strip_tags
# The PDF documentation (fltk.pdf) is generated using doxygen and LaTeX, and
# this needs installed Doxygen and LaTeX programs and may take some time, so
# this target is not made by default.
# Use `make pdf' or `make docs' to create the PDF docs.
pdf: refman.pdf
cp -f latex/refman.pdf fltk.pdf
@ -151,20 +152,8 @@ pdf: refman.pdf
refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex
-$(RMDIR) latex
echo "Generating PDF documentation ..."
$(DOXYDOC) Doxybook ;\
(cd latex ;\
pdflatex --interaction=nonstopmode refman.tex ;\
makeindex refman.idx ;\
pdflatex --interaction=nonstopmode refman.tex ;\
latex_count=5;\
while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log \
&& [ $$latex_count -gt 0 ] ;\
do \
echo "Rerunning latex ..." ;\
pdflatex --interaction=nonstopmode refman.tex ;\
latex_count=`expr $$latex_count - 1` ;\
done ; \
cd ..) > pdfall.log 2>&1
$(DOXYDOC) Doxybook
./make_pdf
src/fltk-book.tex: src/fltk-book.tex.in
DOXY_VERSION=`$(DOXYDOC) --version`; \

47
documentation/make_pdf Executable file
View File

@ -0,0 +1,47 @@
#! /bin/sh
#
# $Id$
#
# Makefile helper script for the Fast Light Tool Kit (FLTK) documentation.
#
# Copyright 1998-2015 by Bill Spitzak and others.
#
# This library is free software. Distribution and use rights are outlined in
# the file "COPYING" which should have been included with this file. If this
# file is missing or damaged, see the license at:
#
# http://www.fltk.org/COPYING.php
#
# Please report all bugs and problems on the following page:
#
# http://www.fltk.org/str.php
#
# This script generates latex/refman.pdf after doxygen has been executed.
#
# Input: run `doxygen Doxybook' (creates files in subdirectory latex)
# Output: latex/refman.pdf (if successful)
#
# Next step: cp -f latex/refman.pdf fltk.pdf (why is this extra step needed ?)
#
# Working directory: fltk/documentation
#
# Used in: Makefile and CMakeLists.txt
( cd latex
pdflatex --interaction=nonstopmode refman.tex
makeindex refman.idx
pdflatex --interaction=nonstopmode refman.tex
latex_count=5
while egrep -s 'Rerun (LaTeX|to get cross-references right)' refman.log \
&& [ $latex_count -gt 0 ]
do
echo "Rerunning pdflatex ..."
pdflatex --interaction=nonstopmode refman.tex
latex_count=`expr $latex_count - 1`
done
cd ..) > pdfall.log 2>&1
#
# End of "$Id$".
#