update doxygen configuration to produce a PDF
A single PDF file for the developer manual allows accessing a single index, browsing, and searching. It takes significantly more time to build this way, but this patch allows others to look at the results. Migration Tip: If you have previously built the HTML Doxygen documentatation, rename your 'doxygen' directory to 'doxygen/html' to prevent needlessly rebuilding those files.
This commit is contained in:
parent
789d47c180
commit
94975c96d4
16
Doxyfile.in
16
Doxyfile.in
|
@ -38,7 +38,7 @@ PROJECT_NUMBER =
|
||||||
# If a relative path is entered, it will be relative to the location
|
# If a relative path is entered, it will be relative to the location
|
||||||
# where doxygen was started. If left blank the current directory will be used.
|
# where doxygen was started. If left blank the current directory will be used.
|
||||||
|
|
||||||
OUTPUT_DIRECTORY =
|
OUTPUT_DIRECTORY = doxygen
|
||||||
|
|
||||||
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
|
||||||
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
# 4096 sub-directories (in 2 levels) under the output directory of each output
|
||||||
|
@ -770,7 +770,7 @@ GENERATE_HTML = YES
|
||||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
||||||
# put in front of it. If left blank `html' will be used as the default path.
|
# put in front of it. If left blank `html' will be used as the default path.
|
||||||
|
|
||||||
HTML_OUTPUT = doxygen
|
HTML_OUTPUT = html
|
||||||
|
|
||||||
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
|
||||||
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
|
||||||
|
@ -981,7 +981,7 @@ FORMULA_FONTSIZE = 10
|
||||||
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
|
||||||
# generate Latex output.
|
# generate Latex output.
|
||||||
|
|
||||||
GENERATE_LATEX = NO
|
GENERATE_LATEX = YES
|
||||||
|
|
||||||
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
|
||||||
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
|
||||||
|
@ -992,7 +992,7 @@ LATEX_OUTPUT = latex
|
||||||
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
|
||||||
# invoked. If left blank `latex' will be used as the default command name.
|
# invoked. If left blank `latex' will be used as the default command name.
|
||||||
|
|
||||||
LATEX_CMD_NAME = latex
|
LATEX_CMD_NAME = pdflatex
|
||||||
|
|
||||||
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
|
||||||
# generate index for LaTeX. If left blank `makeindex' will be used as the
|
# generate index for LaTeX. If left blank `makeindex' will be used as the
|
||||||
|
@ -1004,7 +1004,7 @@ MAKEINDEX_CMD_NAME = makeindex
|
||||||
# LaTeX documents. This may be useful for small projects and may help to
|
# LaTeX documents. This may be useful for small projects and may help to
|
||||||
# save some trees in general.
|
# save some trees in general.
|
||||||
|
|
||||||
COMPACT_LATEX = NO
|
COMPACT_LATEX = YES
|
||||||
|
|
||||||
# The PAPER_TYPE tag can be used to set the paper type that is used
|
# The PAPER_TYPE tag can be used to set the paper type that is used
|
||||||
# by the printer. Possible values are: a4, a4wide, letter, legal and
|
# by the printer. Possible values are: a4, a4wide, letter, legal and
|
||||||
|
@ -1029,20 +1029,20 @@ LATEX_HEADER =
|
||||||
# contain links (just like the HTML output) instead of page references
|
# contain links (just like the HTML output) instead of page references
|
||||||
# This makes the output suitable for online browsing using a pdf viewer.
|
# This makes the output suitable for online browsing using a pdf viewer.
|
||||||
|
|
||||||
PDF_HYPERLINKS = NO
|
PDF_HYPERLINKS = YES
|
||||||
|
|
||||||
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
|
||||||
# plain latex in the generated Makefile. Set this option to YES to get a
|
# plain latex in the generated Makefile. Set this option to YES to get a
|
||||||
# higher quality PDF documentation.
|
# higher quality PDF documentation.
|
||||||
|
|
||||||
USE_PDFLATEX = NO
|
USE_PDFLATEX = YES
|
||||||
|
|
||||||
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
|
||||||
# command to the generated LaTeX files. This will instruct LaTeX to keep
|
# command to the generated LaTeX files. This will instruct LaTeX to keep
|
||||||
# running if errors occur, instead of asking the user for help.
|
# running if errors occur, instead of asking the user for help.
|
||||||
# This option is also used when generating formulas in HTML.
|
# This option is also used when generating formulas in HTML.
|
||||||
|
|
||||||
LATEX_BATCHMODE = NO
|
LATEX_BATCHMODE = YES
|
||||||
|
|
||||||
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
# If LATEX_HIDE_INDICES is set to YES then doxygen will not
|
||||||
# include the index chapters (such as File Index, Compound Index, etc.)
|
# include the index chapters (such as File Index, Compound Index, etc.)
|
||||||
|
|
|
@ -28,9 +28,16 @@ Doxyfile: $(srcdir)/Doxyfile.in
|
||||||
sed -e 's,@srcdir\@,$(srcdir),' $< \
|
sed -e 's,@srcdir\@,$(srcdir),' $< \
|
||||||
) > $@
|
) > $@
|
||||||
|
|
||||||
|
THE_MANUAL = doxygen/latex/refman.pdf
|
||||||
|
|
||||||
doxygen::
|
doxygen::
|
||||||
$(MAKE) Doxyfile
|
$(MAKE) Doxyfile
|
||||||
doxygen Doxyfile 2>&1 | perl $(srcdir)/tools/logger.pl > doxygen.log
|
doxygen Doxyfile 2>&1 | perl $(srcdir)/tools/logger.pl > doxygen.log
|
||||||
|
$(MAKE) $(THE_MANUAL)
|
||||||
|
|
||||||
|
%.pdf: %.tex
|
||||||
|
-cd $$(dirname $*) && pdflatex $$(basename $*)
|
||||||
|
-cd $$(dirname $*) && pdflatex $$(basename $*)
|
||||||
|
|
||||||
TCL_PATH = tcl
|
TCL_PATH = tcl
|
||||||
# command to find paths of script files, relative to TCL_PATH
|
# command to find paths of script files, relative to TCL_PATH
|
||||||
|
|
Loading…
Reference in New Issue