mirror/eigen
2
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2024-12-21 07:19:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
97c0c5d485
eigen/doc/CMakeLists.txt

116 lines
4.7 KiB
CMake
Raw Normal View History

Added cmake project definitions.
2009-10-03 00:45:24 +08:00
project(EigenDoc)
* remove debug code commited by mistake in Assign * keep going on the doc: added a short geometry tutorial
2008-08-27 07:07:33 +08:00
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
set_directory_properties(PROPERTIES EXCLUDE_FROM_ALL TRUE)
now cmake takes snippets of code, completes them into compilable sources, builds them, executes them and stores their output in files.
2007-12-21 17:30:32 +08:00
* added missing project definition (see doc of add_subdirectory and EXCLUDE_FROM_ALL) to fix a win build issue * commented out non-existing unsupported-snippets and -examples
2009-05-17 18:12:39 +08:00
project(EigenDoc)
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
if(CMAKE_COMPILER_IS_GNUCXX)
if(CMAKE_SYSTEM_NAME MATCHES Linux)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O1 -g1")
endif(CMAKE_SYSTEM_NAME MATCHES Linux)
endif(CMAKE_COMPILER_IS_GNUCXX)
* find the proper way of nesting the expression in Flagged: finally that's more subtle than just using ei_nested, because when flagging with NestByValueBit we want to store the expression by value already, regardless of whether it already had the NestByValueBit set. * rename temporary() ----> nestByValue() * move the old Product.h to disabled/, replace by what was ProductWIP.h * tweak -O and -g flags for tests and examples * reorder the tests -- basic things go first * simplifications, e.g. in many methoeds return derived() and count on implicit casting to the actual return type. * strip some not-really-useful stuff from the heaviest tests
2008-05-28 12:38:16 +08:00
Unify c++11 usage in doc's examples and snippets
2018-10-08 23:32:54 +08:00
# some examples and snippets needs c++11, so let's check it once
check_cxx_compiler_flag("-std=c++11" EIGEN_COMPILER_SUPPORT_CPP11)
bug #138: Make building of internal documentation configurable via cmake flag
2014-07-18 20:34:58 +08:00
option(EIGEN_INTERNAL_DOCUMENTATION "Build internal documentation" OFF)
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
# Set some Doxygen flags
set(EIGEN_DOXY_PROJECT_NAME "Eigen")
set(EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX "")
set(EIGEN_DOXY_INPUT "\"${Eigen_SOURCE_DIR}/Eigen\" \"${Eigen_SOURCE_DIR}/doc\"")
set(EIGEN_DOXY_HTML_COLORSTYLE_HUE "220")
set(EIGEN_DOXY_TAGFILES "")
bug #138: Make building of internal documentation configurable via cmake flag
2014-07-18 20:34:58 +08:00
if(EIGEN_INTERNAL_DOCUMENTATION)
set(EIGEN_DOXY_INTERNAL "YES")
else(EIGEN_INTERNAL_DOCUMENTATION)
set(EIGEN_DOXY_INTERNAL "NO")
endif(EIGEN_INTERNAL_DOCUMENTATION)
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit.
2009-02-04 23:37:00 +08:00
configure_file(
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit.
2009-02-04 23:37:00 +08:00
)
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
set(EIGEN_DOXY_PROJECT_NAME "Eigen-unsupported")
set(EIGEN_DOXY_OUTPUT_DIRECTORY_SUFFIX "/unsupported")
set(EIGEN_DOXY_INPUT "\"${Eigen_SOURCE_DIR}/unsupported/Eigen\" \"${Eigen_SOURCE_DIR}/unsupported/doc\"")
set(EIGEN_DOXY_HTML_COLORSTYLE_HUE "0")
Fix most Doxygen warnings. Also add links to stable documentation from unsupported modules (by using the corresponding Doxytags file). Manually grafted from d107a371c61b764c73fd1570b1f3ed1c6400dd7e
2018-10-20 03:10:28 +08:00
set(EIGEN_DOXY_TAGFILES "\"${Eigen_BINARY_DIR}/doc/Eigen.doxytags=..\"")
#set(EIGEN_DOXY_TAGFILES "")
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
configure_file(
first version of CMakeLists auto-generating examples outputs
2007-12-21 17:02:24 +08:00
${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-unsupported
first version of CMakeLists auto-generating examples outputs
2007-12-21 17:02:24 +08:00
)
add example to the documentation
2007-09-28 14:17:36 +08:00
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
configure_file(
Various doc improvements... including a owl in the API doc header.
2008-08-25 18:49:53 +08:00
${CMAKE_CURRENT_SOURCE_DIR}/eigendoxy_header.html.in
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_header.html
)
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
configure_file(
Various doc improvements... including a owl in the API doc header.
2008-08-25 18:49:53 +08:00
${CMAKE_CURRENT_SOURCE_DIR}/eigendoxy_footer.html.in
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_footer.html
)
Big changes in Eigen documentation: - Organize the documentation into "chapters". - Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page. - The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ). - Add a "General topics" entry for all pages that do not fit well in the previous "chapters". - The highlevel struture is managed by a new eigendoxy_layout.xml file. - remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.) - add the javascript search-engine. - add the "treeview" panel. - remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed). - add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel. - overload various javascript function generated by doxygen to: - remove the root of the treeview - remove links to section/subsection from the treeview - automatically expand the "Chapters" section - automatically expand the current section - adjust the height of the treeview to take into account the TOC - always use the default .css file, eigendoxy.css now only includes our modifications - use Doxyfile to specify our logo - remove cross references to unsupported modules (temporarily)
2013-01-05 23:37:11 +08:00
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/eigendoxy_layout.xml.in
${CMAKE_CURRENT_BINARY_DIR}/eigendoxy_layout.xml
)
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
configure_file(
${Eigen_SOURCE_DIR}/unsupported/doc/eigendoxy_layout.xml.in
${Eigen_BINARY_DIR}/doc/unsupported/eigendoxy_layout.xml
)
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
set(examples_targets "")
set(snippets_targets "")
everything works, make now runs doxygen once and only once, after all the required files have been generated.
2007-12-21 19:29:04 +08:00
introduce EIGEN_MAKING_DOCS to tell whether we're compiling the docs examples
2011-02-07 01:51:42 +08:00
add_definitions("-DEIGEN_MAKING_DOCS")
fix bug #499: the image was missing because of a dependency issue when building/executing the "special" examples
2012-08-27 17:11:25 +08:00
add_custom_target(all_examples)
Use an aligned IOFormat in the docs
2008-12-07 07:20:30 +08:00
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
add_subdirectory(examples)
significantly extend the tutorial of sparse matrices
2012-06-20 15:28:32 +08:00
add_subdirectory(special_examples)
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
add_subdirectory(snippets)
now cmake takes snippets of code, completes them into compilable sources, builds them, executes them and stores their output in files.
2007-12-21 17:30:32 +08:00
prefix all Eigen cmake variable with EIGEN_ and switched to lowercase for all cmake files
2008-12-02 20:59:10 +08:00
add_custom_target(
fix doxygen generation of unsupported modules
2009-03-11 21:11:38 +08:00
doc-eigen-prerequisites
everything works, make now runs doxygen once and only once, after all the required files have been generated.
2007-12-21 19:29:04 +08:00
ALL
* missing cmake make_directory command * show svn revision number if available * fix warnings about unused argc/argv Gael: I just saw your latest docs, it's completely awesome.
2008-08-27 14:43:42 +08:00
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/html/
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/eigen_navtree_hacks.js ${CMAKE_CURRENT_BINARY_DIR}/html/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Eigen_Silly_Professor_64x64.png ${CMAKE_CURRENT_BINARY_DIR}/html/
Add some doxygen's images to support both old and recent doxygen versions (with some vague definitions of old and recent ;) )
2016-07-12 22:45:43 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/ftv2pnode.png ${CMAKE_CURRENT_BINARY_DIR}/html/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/ftv2node.png ${CMAKE_CURRENT_BINARY_DIR}/html/
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/AsciiQuickReference.txt ${CMAKE_CURRENT_BINARY_DIR}/html/
everything works, make now runs doxygen once and only once, after all the required files have been generated.
2007-12-21 19:29:04 +08:00
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit.
2009-02-04 23:37:00 +08:00
add_custom_target(
fix doxygen generation of unsupported modules
2009-03-11 21:11:38 +08:00
doc-unsupported-prerequisites
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit.
2009-02-04 23:37:00 +08:00
ALL
COMMAND ${CMAKE_COMMAND} -E make_directory ${Eigen_BINARY_DIR}/doc/html/unsupported
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/eigen_navtree_hacks.js ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/Eigen_Silly_Professor_64x64.png ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
Add some doxygen's images to support both old and recent doxygen versions (with some vague definitions of old and recent ;) )
2016-07-12 22:45:43 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/ftv2pnode.png ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/ftv2node.png ${CMAKE_CURRENT_BINARY_DIR}/html/unsupported/
setup the unsupported directory structure. The unsupported module documentation is automatically generated in: build/doc/unsupported/ with bidirectional cross references. I leave a class Foo in AdolcForward module to illustrate the cross-reference behavior. I will remove it in the next commit.
2009-02-04 23:37:00 +08:00
WORKING_DIRECTORY ${Eigen_BINARY_DIR}/doc
)
fix doxygen generation of unsupported modules
2009-03-11 21:11:38 +08:00
add_dependencies(doc-eigen-prerequisites all_snippets all_examples)
Fixed the bad fix - now the unsupported examples and snippets work on windows.
2009-12-12 02:39:01 +08:00
add_dependencies(doc-unsupported-prerequisites unsupported_snippets unsupported_examples)
Automatically produce a tgz archive of the documentation.
2011-11-06 04:59:36 +08:00
fix doxygen generation of unsupported modules
2009-03-11 21:11:38 +08:00
add_custom_target(doc ALL
COMMAND doxygen
update unsupported module documentation to be conformed with new documentation style
2013-01-11 17:41:26 +08:00
COMMAND doxygen Doxyfile-unsupported
bug #804: copy group__TopicUnalignedArrayAssert.html to TopicUnalignedArrayAssert.html as the second is linked to by old Eigen versions.
2014-09-08 04:38:09 +08:00
COMMAND ${CMAKE_COMMAND} -E copy ${Eigen_BINARY_DIR}/doc/html/group__TopicUnalignedArrayAssert.html ${Eigen_BINARY_DIR}/doc/html/TopicUnalignedArrayAssert.html
Automatically produce a tgz archive of the documentation.
2011-11-06 04:59:36 +08:00
COMMAND ${CMAKE_COMMAND} -E rename html eigen-doc
Do not keep latex logs to make package builds more reproducible. See https://reproducible-builds.org/ for why this is good.
2019-02-27 18:09:00 +08:00
COMMAND ${CMAKE_COMMAND} -E remove eigen-doc/eigen-doc.tgz eigen-doc/unsupported/_formulas.log eigen-doc/_formulas.log
Fix bug #961: eigen-doc.tgz included part of itself.
2015-02-18 22:47:01 +08:00
COMMAND ${CMAKE_COMMAND} -E tar cfz eigen-doc.tgz eigen-doc
COMMAND ${CMAKE_COMMAND} -E rename eigen-doc.tgz eigen-doc/eigen-doc.tgz
Automatically produce a tgz archive of the documentation.
2011-11-06 04:59:36 +08:00
COMMAND ${CMAKE_COMMAND} -E rename eigen-doc html
fix bug #499: the image was missing because of a dependency issue when building/executing the "special" examples
2012-08-27 17:11:25 +08:00
WORKING_DIRECTORY ${Eigen_BINARY_DIR}/doc)
Automatically produce a tgz archive of the documentation.
2011-11-06 04:59:36 +08:00
fix doxygen generation of unsupported modules
2009-03-11 21:11:38 +08:00
add_dependencies(doc doc-eigen-prerequisites doc-unsupported-prerequisites)
Reference in New Issue Copy Permalink