Merge branch 'documentation' into 'develop'

/Debug

/Release

/Testing

/Documentation

/Documentation/html/

/CMakeLists.txt.user

/doc/_build

/Build

# Eclipse project stuff

Oberhuber Tomas <tomas.oberhuber@fjfi.cvut.cz>

Zabka Vitezslav <zabkav@gmail.com>

Vladimir Klement <wlada@post.cz>

Tomáš Sobotík <sobotik.tomas@gmail.com>

Ondřej Székely <ondra.szekely@gmail.com>

Libor Bakajsa

Jakub Klinkovský <klinkjak@fjfi.cvut.cz>

Vacata Jan

Heller Martin

Novotny Matej

#    email               : tomas.oberhuber@fjfi.cvut.cz

#

###############################################################################

#

# Authors:

# Tomas Oberhuber

# Vladimir Klement

# Jakub Klinkovsky

cmake_minimum_required( VERSION 3.5.1 )

option(WITH_TOOLS "Compile the 'src/Tools' directory" ON)

option(WITH_BENCHMARKS "Compile the 'src/Benchmarks' directory" ON)

option(WITH_PYTHON "Compile the Python bindings" ON)

option(WITH_DOC "Generate documentation" ON)

option(WITH_TEMPLATES_INSTANTIATION "Enable explicit template instantiation" OFF)

# install paths relative to the cmake's prefix

add_subdirectory( src )

add_subdirectory( share )

#Check for Doxygen

if( ${WITH_DOC} )

    find_package(Doxygen)

    if( DOXYGEN_FOUND )

        if( CMAKE_BUILD_TYPE MATCHES "Release" )

            add_subdirectory( Documentation )

        endif( CMAKE_BUILD_TYPE MATCHES "Release" )

    else( DOXYGEN_FOUND )

        message("Doxygen need to be installed to generate the doxygen documentation")

    endif( DOXYGEN_FOUND )

endif( ${WITH_DOC} )

set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Template Numerical Library")

set(CPACK_PACKAGE_VENDOR "MMG")

#set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/ReadMe.txt")

add_subdirectory( Tutorials )

## set input and output files

#set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)

#set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)

#

## request to configure the file

#configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)

#

## note the option ALL which allows to build the docs together with the application

#add_custom_target( doc_doxygen ALL

#    COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}

#    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}

#    COMMENT "Generating API documentation with Doxygen"

#    VERBATIM )

#

#INSTALL( DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_PREFIX}/share/doc/tnl )

#

# entered, it will be relative to the location where doxygen was started. If

# left blank the current directory will be used.

OUTPUT_DIRECTORY       = Documentation

OUTPUT_DIRECTORY       =

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-

# directories (in 2 levels) under the output directory of each output format and

# will be relative from the directory where doxygen is started.

# This tag requires that the tag FULL_PATH_NAMES is set to YES.

STRIP_FROM_PATH        =

STRIP_FROM_PATH        = ../

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the

# path mentioned in the documentation of a class, which tells the reader which

# globally by setting AUTOLINK_SUPPORT to NO.

# The default value is: YES.

AUTOLINK_SUPPORT       = YES

AUTOLINK_SUPPORT       = NO

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want

# to include (a tag file for) the STL sources as input, then you should set this

# diagrams that involve STL classes more complete and accurate.

# The default value is: NO.

BUILTIN_STL_SUPPORT    = NO

BUILTIN_STL_SUPPORT    = YES

# If you use Microsoft's C++/CLI language, you should set this option to YES to

# enable parsing support.

# list.

# The default value is: NO.

SORT_BY_SCOPE_NAME     = NO

SORT_BY_SCOPE_NAME     = YES

# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper

# type resolution of all parameters of a function it will reject a match between

# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING

# Note: If this tag is empty the current directory is searched.

INPUT                  = src/TNL

INPUT = main-page.md

INPUT += ../src/TNL

# This tag can be used to specify the character encoding of the source files

# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

# 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       = */Communicators/* \

                         */Config/* \

                         */Debugging/* \

                         */Devices/* \

                         */DistributedContainers/* \

                         */Exceptions/* \

EXCLUDE_PATTERNS       = */Debugging/* \

                         */Experimental/* \

                         */Functions/* \

                         */Images/* \

                         */Matrices/* \

                         */Meshes/* \

                         */Operators/* \

                         */Pointers/* \

                         */Problems/* \

                         */Solvers/* 

                         */Meshes/GridDetails/* \

                         */Meshes/MeshDetails/* \

                         */Problems/*

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names

# Note that the wildcards are matched against the file with absolute path, so to

# exclude all test directories use the pattern */test/*

EXCLUDE_SYMBOLS        =

EXCLUDE_SYMBOLS = detail::*,*::detail::*  # internal namespaces

EXCLUDE_SYMBOLS += *::__*impl  # internal namespaces

EXCLUDE_SYMBOLS += TNL::Assert::*  # internal namespace

# The EXAMPLE_PATH tag can be used to specify one or more files or directories

# that contain example code fragments that are included (see the \include

# command).

EXAMPLE_PATH           = src/Examples

EXAMPLE_PATH           = ../src/Examples

# If the value of the EXAMPLE_PATH tag contains directories, you can use the

# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and

# (index.html). This can be useful if you have a project on for instance GitHub

# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =

USE_MDFILE_AS_MAINPAGE = main-page.md

#---------------------------------------------------------------------------

# Configuration options related to source browsing

# See also: Section \class.

# The default value is: YES.

VERBATIM_HEADERS       = YES

VERBATIM_HEADERS       = NO

# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the

# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the

# files will be copied as-is; there are no commands or markers available.

# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES       =

HTML_EXTRA_FILES       = tnl-logo.jpg

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen

# will adjust the colors in the style sheet and background images according to

# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.

# The default value is: YES.

GENERATE_LATEX         = YES

GENERATE_LATEX         = NO

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a

# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

# the path). If a tag file is not located in the directory in which doxygen is

# run, you must also specify the path to the tagfile here.

TAGFILES               =

# archive for cppreference.com can be found here:

# https://en.cppreference.com/w/Cppreference:Archives#Doxygen_tag_file

TAGFILES = "cppreference-doxygen-web.tag.xml=https://en.cppreference.com/w/"

# When a file name is specified after GENERATE_TAGFILE, doxygen will create a

# tag file that is based on the input files it reads. See section "Linking to