search

blitzpp / blitz

Blitz++ Multi-Dimensional Array Library for C++
https://github.com/blitzpp/blitz/wiki
Other
404 stars 83 forks source link

doc-generation option in CMake #127

Open slayoo opened 5 years ago

slayoo commented 5 years ago

Not sure if this is what we need. To be clear, here is how these things SHOULD work: There should be a CMake option (looks like DOCS) that turns on generation of documentation. If that option is not set, then no docs are generated. If the option IS set, then docs will be generated. If the option is set and the required programs for generating docs do not exist (pdflatex and texi2pdf), then CMake should generate an error. It should NOT "automagically" decide whether or not to generate docs depending on whether it can find the required programs. That will cause people unending grief ("I set DOCS but docs weren't generated"), and is against best practices.

Originally posted by @citibeth in https://github.com/blitzpp/blitz/pull/97

WalterZimmer314 commented 4 years ago

I understand this is what needs to done to generate the docs with blitz version 1.0.2: mkdir build cd build cmake .. -DBUILD_DOC=ON make blitz-doc

It lets doxygen run a lot of thing, but latex aborts due to errors, so there is no pdf. Did I do anything wrong? Thanks!