diff --git a/CMakeLists.txt b/CMakeLists.txt index 5c3818db5d..74384ec91d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 3.6) +cmake_minimum_required(VERSION 3.9) project(LAPACK) @@ -615,24 +615,21 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION) set(DOXYGEN_PROJECT_BRIEF "LAPACK: Linear Algebra PACKage") set(DOXYGEN_PROJECT_NUMBER ${LAPACK_VERSION}) - set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/DOCS) - set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/DOCS/lapack.png) + set(DOXYGEN_OUTPUT_DIRECTORY DOCS) + set(DOXYGEN_PROJECT_LOGO DOCS/lapack.png) set(DOXYGEN_OPTIMIZE_FOR_FORTRAN YES) set(DOXYGEN_SOURCE_BROWSER YES) set(DOXYGEN_CREATE_SUBDIRS YES) set(DOXYGEN_SEPARATE_MEMBER_PAGES YES) + set(DOXYGEN_TAB_SIZE 8) set(DOXYGEN_EXTRACT_ALL YES) set(DOXYGEN_FILE_PATTERNS *.f *.f90 *.c *.h ) set(DOXYGEN_RECURSIVE YES) set(DOXYGEN_GENERATE_TREEVIEW YES) set(DOXYGEN_DOT_IMAGE_FORMAT svg) set(DOXYGEN_INTERACTIVE_SVG YES) - set(DOXYGEN_QUIET NO) - set(DOXYGEN_WARNINGS YES) set(DOXYGEN_WARN_NO_PARAMDOC YES) set(DOXYGEN_WARN_LOGFILE doxygen_error) - set(DOXYGEN_GENERATE_HTML NO) - set(DOXYGEN_GENERATE_MAN NO) set(DOXYGEN_LAYOUT_FILE "DOCS/DoxygenLayout.xml") # Exclude functions that are duplicated, creating conflicts. @@ -647,46 +644,52 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION) if (BUILD_HTML_DOCUMENTATION) set(DOXYGEN_GENERATE_HTML YES) - set(DOXYGEN_HTML_OUTPUT explore-html) + set(DOXYGEN_GENERATE_MAN NO) set(DOXYGEN_INLINE_SOURCES YES) set(DOXYGEN_CALL_GRAPH YES) set(DOXYGEN_CALLER_GRAPH YES) + set(DOXYGEN_HTML_OUTPUT explore-html) + set(DOXYGEN_HTML_TIMESTAMP YES) doxygen_add_docs( html # Doxygen INPUT = - ${PROJECT_SOURCE_DIR}/README.md - ${PROJECT_SOURCE_DIR}/BLAS - ${PROJECT_SOURCE_DIR}/CBLAS - ${PROJECT_SOURCE_DIR}/SRC - ${PROJECT_SOURCE_DIR}/INSTALL - ${PROJECT_SOURCE_DIR}/TESTING - ${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox + BLAS + CBLAS + SRC + INSTALL + TESTING + DOCS/groups-usr.dox + README.md COMMENT "Generating html LAPACK documentation (it will take some time... time to grab a coffee)" ) + unset(DOXYGEN_HTML_OUTPUT) + unset(DOXYGEN_HTML_TIMESTAMP) endif() if (BUILD_MAN_DOCUMENTATION) + set(DOXYGEN_GENERATE_HTML NO) set(DOXYGEN_GENERATE_MAN YES) - set(DOXYGEN_MAN_LINKS YES) set(DOXYGEN_INLINE_SOURCES NO) set(DOXYGEN_CALL_GRAPH NO) set(DOXYGEN_CALLER_GRAPH NO) + set(DOXYGEN_MAN_LINKS YES) doxygen_add_docs( man # Doxygen INPUT = - ${PROJECT_SOURCE_DIR}/BLAS - ${PROJECT_SOURCE_DIR}/CBLAS - ${PROJECT_SOURCE_DIR}/SRC - ${PROJECT_SOURCE_DIR}/INSTALL - ${PROJECT_SOURCE_DIR}/TESTING - ${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox + BLAS + CBLAS + SRC + INSTALL + TESTING + DOCS/groups-usr.dox COMMENT "Generating man LAPACK documentation" ) + unset(DOXYGEN_MAN_LINKS) endif() endif() diff --git a/DOCS/Doxyfile b/DOCS/Doxyfile index 577675772c..5cdf3208c4 100644 --- a/DOCS/Doxyfile +++ b/DOCS/Doxyfile @@ -126,7 +126,17 @@ REPEAT_BRIEF = YES # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. -ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief @@ -885,9 +895,9 @@ INPUT_ENCODING = UTF-8 # *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, # *.ucf, *.qsf and *.ice. -FILE_PATTERNS = *.c \ - *.f \ +FILE_PATTERNS = *.f \ *.f90 \ + *.c \ *.h # The RECURSIVE tag can be used to specify whether or not subdirectories should @@ -927,11 +937,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = *.py \ - *.txt \ - *.in \ - *.inc \ - Makefile +EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -955,7 +961,7 @@ EXAMPLE_PATH = # *.h) to filter out the source-files in the directories. If left blank all # files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands @@ -1602,7 +1608,7 @@ MATHJAX_FORMAT = HTML-CSS # The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = http://www.mathjax.org/mathjax +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example @@ -1735,7 +1741,7 @@ LATEX_OUTPUT = latex # the output language. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_CMD_NAME = latex +LATEX_CMD_NAME = # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate # index for LaTeX. @@ -1938,7 +1944,7 @@ COMPACT_RTF = NO # The default value is: NO. # This tag requires that the tag GENERATE_RTF is set to YES. -RTF_HYPERLINKS = YES +RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # configuration file, i.e. a series of assignments. You only have to provide @@ -2009,7 +2015,7 @@ MAN_SUBDIR = # The default value is: NO. # This tag requires that the tag GENERATE_MAN is set to YES. -MAN_LINKS = YES +MAN_LINKS = NO #--------------------------------------------------------------------------- # Configuration options related to the XML output