Automatically produce a tgz archive of the documentation.

This commit is contained in:
Gael Guennebaud 2011-11-05 21:59:36 +01:00
parent b4d1d4a2e0
commit cdd3e85060
2 changed files with 6 additions and 1 deletions

View File

@ -64,9 +64,14 @@ add_custom_target(
add_dependencies(doc-eigen-prerequisites all_snippets all_examples)
add_dependencies(doc-unsupported-prerequisites unsupported_snippets unsupported_examples)
add_custom_target(doc ALL
COMMAND doxygen Doxyfile-unsupported
COMMAND doxygen
COMMAND doxygen Doxyfile-unsupported # run doxygen twice to get proper eigen <=> unsupported cross references
COMMAND ${CMAKE_COMMAND} -E rename html eigen-doc
COMMAND ${CMAKE_COMMAND} -E tar cvfz eigen-doc/eigen-doc.tgz eigen-doc/*.html eigen-doc/*.map eigen-doc/*.png eigen-doc/*.css eigen-doc/*.js eigen-doc/*.txt eigen-doc/unsupported
COMMAND ${CMAKE_COMMAND} -E rename eigen-doc html
WORKING_DIRECTORY ${Eigen_BINARY_DIR}/doc)
add_dependencies(doc doc-eigen-prerequisites doc-unsupported-prerequisites)

View File

@ -8,7 +8,7 @@ o /** \mainpage Eigen
| \ref QuickRefPage "Short reference"
</div>
This is the API documentation for Eigen3.
This is the API documentation for Eigen3. You can <a href="eigen-doc.tgz">download</a> it as a tgz archive for offline reading.
Eigen2 users: here is a \ref Eigen2ToEigen3 guide to help porting your application.