How to get a single PDF document from Doxygen?

Question

When I generate Doxygen documentation in PDF format, I get plenty of different files with a single diagram in each.
Is it possible to obtain a single PDF document, organized as a book, roughly as the HTML version?
Is it possible to get it automatically, i.e. without dealing manually with the latex files?

Thank's!

score 47 · Accepted Answer · edited Jun 10 '15 at 22:16

47

See Converting a LaTeX document to a PDF document.

When Doxygen is finished processing, in the latex directory there's a file called 'refman.tex'.

There are three ways you can use that file to get 'a book' out of Doxygen:

LaTeX -> dvips -> ps2pdf

latex myfile

dvips myfile

ps2pdf myfile.ps
LaTeX -> dvipdfm

latex myfile

dvipdfm myfile
pdflatex (or pdftex for plain TeX)

pdflatex myfile

edited Jun 10 '15 at 22:16

cp.engr

2,291
4
28
42

answered Jul 31 '11 at 11:00

synthesizerpatel

27,321
5
74
91

Owl · Answer 2 · 2020-01-27T13:32:53.877

24

Assuming that doxygen is configured correctly, under Linux:

doxygen
cd latex
make

The generated file will be refman.pdf unless it's configured otherwise.

edited Jan 27 '20 at 13:32

answered Feb 17 '15 at 20:22

Owl

1,446
14
20

Denise Skidmore · Answer 3 · 2018-04-12T18:56:54.613

21

Using Doxygen 1.8.4+ (on Windows), there is also a make.bat script so you don't even need to open the command line.

Configure Doxygen for LaTeX output.

GENERATE_LATEX = YES LATEX_OUTPUT = latex OUTPUT_DIRECTORY =
Set up all your images for LaTeX output.

\image html application.jpg \image latex application.eps "My application" width=10cm
Run Doxygen.
Run {OUTPUT_DIRECTORY}\{LATEX_OUTPUT}\make.bat.
Open {OUTPUT_DIRECTORY}\{LATEX_OUTPUT}\refman.pdf.

If refman.pdf is not created, run make.bat from a command window and read the errors.

Errors like: 'pdflatex' is not recognized as an internal or external command,... Mean that you do not have the prerequisites to run latex at all. Other errors may be due to missing latex packages or doxygen bugs causing invalid .tex files.

Once you have all the prerequisites installed, and a good version of doxygen, the simpler procedure should work every time.

edited Apr 12 '18 at 18:56

answered Jan 23 '14 at 20:22

Denise Skidmore

2,286
22
51

1

make.bat is generated by the windows version, on Linux the generated file is called Makefile. – Étienne Jul 30 '14 at 16:04
Do you have to pass that to make, or is it a script? – Denise Skidmore Jul 30 '14 at 19:35
It's executed by make – Étienne Jul 30 '14 at 20:40
4

On Linux, type "make" in the "latex" directory. The generated document is "refman.pdf". – nvd Sep 23 '14 at 17:59
In my case all the image specified via \image are missing. Am I missing anything? – elgnoh Apr 28 '15 at 16:00
Are you specifying separate image commands for latex and html output? – Denise Skidmore Apr 28 '15 at 19:17
You need to have a separate image command for each format of output: http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdimage – Denise Skidmore Apr 28 '15 at 19:18
The other easy thing to check is your image path. http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_image_path – Denise Skidmore Apr 28 '15 at 19:19
In Cygwin after I run `make`, I get error message: `pdflatex command not found`. Any idea how to make it work in Cygwin? – Danijel Feb 20 '17 at 12:49
Did you install LaTeX? Is it in the path for Cygwin? – Denise Skidmore Feb 20 '17 at 16:56
This did not work for me. I ran the `make.bat` file, but it did not create any output folder in the latex folder – Pete Mar 28 '18 at 17:47
did it print out any errors? run from a console rather than double-clicking so you can see what it prints to screen. – Denise Skidmore Mar 28 '18 at 19:50
It won't create a new folder, just a new file. Your Doxygen output needs to output a latex folder. Inside the latex folder is your make.bat, and in the same folder you should find refman.pdf. – Denise Skidmore Mar 28 '18 at 19:53

score 13 · Answer 4 · answered Dec 20 '12 at 19:01

13

Patel is right - you need to run Doxygen, then Latex of some sort to create the single doc.

For me, using Doxygen 1.7.3, the root file for the latex build seems to be "refman.tex".

Doxygen creates a Makefile, too, so if you've got make (I don't on my Win7 box), you can just type make in the latex directory.

I point my TeXnicCenter app at refman.tex, and build that way.

Hope this helps,

-Matt

answered Dec 20 '12 at 19:01

Matt

500
1
12
21

Doxygen has also a make.bat on Windows systems and theer is a Makefile (for a *nix make) – albert Mar 17 '20 at 08:55

score 6 · Answer 5 · answered Apr 04 '14 at 18:30

6

Other people didn't mention a detail:

For the pdflatex route to work, your current working directory needs to be the generated latex folder, otherwise you get errors like doxygen.sty cannot be found.

answered Apr 04 '14 at 18:30

kakyo

10,460
14
76
140

score 1 · Answer 6 · answered Mar 16 '20 at 20:52

I would add one additional advise. Don't ignore the latex warnings. pdflatex can fail to produce an output file as well as any meaningful errors.

I had a similar annoying situation and just fixing all the warnings helped to produce the correct output file without any further issues.

How to get a single PDF document from Doxygen?

6 Answers6

Linked