Commit 6c3bc7ca authored by Jakub Klinkovský's avatar Jakub Klinkovský
Browse files

Reorganized building of documentation and navigation to tutorials

parent c5d01430

CMakeLists.txt

+2 −2
Original line number Diff line number Diff line
@@ -222,7 +222,7 @@ if( ${WITH_CUDA} ) 
                    # strip linebreaks and convert to list delimited with ';'

                    string( REGEX REPLACE "[\n ]" ";" CUDA_ARCH ${CUDA_ARCH} )

                    # cache the result

                    set( CUDA_ARCH ${CUDA_ARCH} CACHE LIST "GPU architecture options" )

                    set( CUDA_ARCH ${CUDA_ARCH} CACHE STRING "GPU architecture options" )

                else()

                    message( "Failed to detect GPU architecture:\n${CUDA_ARCH_OUTPUT}" )

                    message( "Using (almost) all GPU architectures as fallback." )
@@ -383,7 +383,7 @@ if( ${WITH_DOC} ) 
    find_package(Doxygen)

    if( DOXYGEN_FOUND )

        if( CMAKE_BUILD_TYPE MATCHES "Release" )

            add_subdirectory( Documentation )

            add_subdirectory( Documentation/Tutorials )

        endif( CMAKE_BUILD_TYPE MATCHES "Release" )

    else( DOXYGEN_FOUND )

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

Documentation/CMakeLists.txt

deleted100644 → 0
+0 −17
Original line number Diff line number Diff line 
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 )

Documentation/Tutorials/Vectors/Doxyfile.in→Documentation/Doxyfile

+18 −8
Original line number Diff line number Diff line
@@ -58,7 +58,7 @@ PROJECT_LOGO = 
# entered, it will be relative to the location where doxygen was started. If

# left blank the current directory will be used.



OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@

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
@@ -702,8 +702,10 @@ FILE_VERSION_FILTER = 
# Note that if you run doxygen from a directory containing a file called

# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE

# tag is left empty.

#

# See http://www.doxygen.nl/manual/customize.html#layout for details.



LAYOUT_FILE            =

LAYOUT_FILE            = DoxygenLayout.xml



# The CITE_BIB_FILES tag can be used to specify one or more bib files containing

# the reference definitions. This must be a list of .bib files. The .bib
@@ -790,8 +792,9 @@ WARN_LOGFILE = 
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING

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



INPUT = @CMAKE_CURRENT_SOURCE_DIR@/main-page.md

INPUT += @CMAKE_CURRENT_SOURCE_DIR@/../src/TNL

INPUT = main-page.md

INPUT += ../src/TNL

INPUT += Tutorials



# 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
@@ -895,6 +898,10 @@ EXCLUDE_PATTERNS = */Debugging/* \ 
                         */Meshes/GridDetails/* \

                         */Meshes/MeshDetails/* \

                         */Problems/*

# skip documentation in code snippets

EXCLUDE_PATTERNS += */Tutorials/*.h

EXCLUDE_PATTERNS += */Tutorials/*.cpp

EXCLUDE_PATTERNS += */Tutorials/*.cu





# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
@@ -914,8 +921,11 @@ EXCLUDE_SYMBOLS += TNL::Assert::* # internal namespace 
# that contain example code fragments that are included (see the \include

# command).



EXAMPLE_PATH           = @CMAKE_CURRENT_SOURCE_DIR@ \

                         @CMAKE_CURRENT_BINARY_DIR@

EXAMPLE_PATH += ../src/Examples

EXAMPLE_PATH += Tutorials

# directories for output snippets

EXAMPLE_PATH += ../Release/Documentation/Tutorials

EXAMPLE_PATH += ../Debug/Documentation/Tutorials



# 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
@@ -929,7 +939,7 @@ EXAMPLE_PATTERNS = * 
# irrespective of the value of the RECURSIVE tag.

# The default value is: NO.



EXAMPLE_RECURSIVE      = NO

EXAMPLE_RECURSIVE      = YES



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

# that contain images that are to be included in the documentation (see the
@@ -1211,7 +1221,7 @@ HTML_EXTRA_STYLESHEET = 
# 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       = @PROJECT_SOURCE_DIR@/Documentation/tnl-logo.jpg

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

Documentation/Doxyfile.in

deleted100644 → 0
+0 −2506

File deleted.

Preview size limit exceeded, changes collapsed.

Documentation/DoxygenLayout.xml

0 → 100644
+228 −0
Original line number Diff line number Diff line 
<doxygenlayout version="1.0">

  <!-- Generated by doxygen 1.8.15 -->

  <!-- Navigation index tabs for HTML output -->

  <navindex>

    <tab type="mainpage" visible="yes" title=""/>

    <tab type="user" visible="yes" title="Tutorials" url="@ref Tutorials" />

    <tab type="modules" visible="yes" title="" intro=""/>

    <tab type="namespaces" visible="yes" title="">

      <tab type="namespacelist" visible="yes" title="" intro=""/>

      <tab type="namespacemembers" visible="yes" title="" intro=""/>

    </tab>

    <tab type="interfaces" visible="yes" title="">

      <tab type="interfacelist" visible="yes" title="" intro=""/>

      <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/> 

      <tab type="interfacehierarchy" visible="yes" title="" intro=""/>

    </tab>

    <tab type="classes" visible="yes" title="">

      <tab type="classlist" visible="yes" title="" intro=""/>

      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 

      <tab type="hierarchy" visible="yes" title="" intro=""/>

      <tab type="classmembers" visible="yes" title="" intro=""/>

    </tab>

    <tab type="structs" visible="yes" title="">

      <tab type="structlist" visible="yes" title="" intro=""/>

      <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/> 

    </tab>

    <tab type="exceptions" visible="yes" title="">

      <tab type="exceptionlist" visible="yes" title="" intro=""/>

      <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/> 

      <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>

    </tab>

    <tab type="pages" visible="yes" title="" intro=""/>

    <tab type="files" visible="yes" title="">

      <tab type="filelist" visible="yes" title="" intro=""/>

      <tab type="globals" visible="yes" title="" intro=""/>

    </tab>

    <tab type="examples" visible="yes" title="" intro=""/>  

    <tab type="user" visible="yes" title="tnl-project.org" url="https://tnl-project.org/" />

  </navindex>



  <!-- Layout definition for a class page -->

  <class>

    <briefdescription visible="yes"/>

    <includes visible="$SHOW_INCLUDE_FILES"/>

    <inheritancegraph visible="$CLASS_GRAPH"/>

    <collaborationgraph visible="$COLLABORATION_GRAPH"/>

    <memberdecl>

      <nestedclasses visible="yes" title=""/>

      <publictypes title=""/>

      <services title=""/>

      <interfaces title=""/>

      <publicslots title=""/>

      <signals title=""/>

      <publicmethods title=""/>

      <publicstaticmethods title=""/>

      <publicattributes title=""/>

      <publicstaticattributes title=""/>

      <protectedtypes title=""/>

      <protectedslots title=""/>

      <protectedmethods title=""/>

      <protectedstaticmethods title=""/>

      <protectedattributes title=""/>

      <protectedstaticattributes title=""/>

      <packagetypes title=""/>

      <packagemethods title=""/>

      <packagestaticmethods title=""/>

      <packageattributes title=""/>

      <packagestaticattributes title=""/>

      <properties title=""/>

      <events title=""/>

      <privatetypes title=""/>

      <privateslots title=""/>

      <privatemethods title=""/>

      <privatestaticmethods title=""/>

      <privateattributes title=""/>

      <privatestaticattributes title=""/>

      <friends title=""/>

      <related title="" subtitle=""/>

      <membergroups visible="yes"/>

    </memberdecl>

    <detaileddescription title=""/>

    <memberdef>

      <inlineclasses title=""/>

      <typedefs title=""/>

      <enums title=""/>

      <services title=""/>

      <interfaces title=""/>

      <constructors title=""/>

      <functions title=""/>

      <related title=""/>

      <variables title=""/>

      <properties title=""/>

      <events title=""/>

    </memberdef>

    <allmemberslink visible="yes"/>

    <usedfiles visible="$SHOW_USED_FILES"/>

    <authorsection visible="yes"/>

  </class>



  <!-- Layout definition for a namespace page -->

  <namespace>

    <briefdescription visible="yes"/>

    <memberdecl>

      <nestednamespaces visible="yes" title=""/>

      <constantgroups visible="yes" title=""/>

      <interfaces visible="yes" title=""/>

      <classes visible="yes" title=""/>

      <structs visible="yes" title=""/>

      <exceptions visible="yes" title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <functions title=""/>

      <variables title=""/>

      <membergroups visible="yes"/>

    </memberdecl>

    <detaileddescription title=""/>

    <memberdef>

      <inlineclasses title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <functions title=""/>

      <variables title=""/>

    </memberdef>

    <authorsection visible="yes"/>

  </namespace>



  <!-- Layout definition for a file page -->

  <file>

    <briefdescription visible="yes"/>

    <includes visible="$SHOW_INCLUDE_FILES"/>

    <includegraph visible="$INCLUDE_GRAPH"/>

    <includedbygraph visible="$INCLUDED_BY_GRAPH"/>

    <sourcelink visible="yes"/>

    <memberdecl>

      <interfaces visible="yes" title=""/>

      <classes visible="yes" title=""/>

      <structs visible="yes" title=""/>

      <exceptions visible="yes" title=""/>

      <namespaces visible="yes" title=""/>

      <constantgroups visible="yes" title=""/>

      <defines title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <functions title=""/>

      <variables title=""/>

      <membergroups visible="yes"/>

    </memberdecl>

    <detaileddescription title=""/>

    <memberdef>

      <inlineclasses title=""/>

      <defines title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <functions title=""/>

      <variables title=""/>

    </memberdef>

    <authorsection/>

  </file>



  <!-- Layout definition for a group page -->

  <group>

    <briefdescription visible="yes"/>

    <groupgraph visible="$GROUP_GRAPHS"/>

    <memberdecl>

      <nestedgroups visible="yes" title=""/>

      <dirs visible="yes" title=""/>

      <files visible="yes" title=""/>

      <namespaces visible="yes" title=""/>

      <classes visible="yes" title=""/>

      <defines title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <enumvalues title=""/>

      <functions title=""/>

      <variables title=""/>

      <signals title=""/>

      <publicslots title=""/>

      <protectedslots title=""/>

      <privateslots title=""/>

      <events title=""/>

      <properties title=""/>

      <friends title=""/>

      <membergroups visible="yes"/>

    </memberdecl>

    <detaileddescription title=""/>

    <memberdef>

      <pagedocs/>

      <inlineclasses title=""/>

      <defines title=""/>

      <typedefs title=""/>

      <sequences title=""/>

      <dictionaries title=""/>

      <enums title=""/>

      <enumvalues title=""/>

      <functions title=""/>

      <variables title=""/>

      <signals title=""/>

      <publicslots title=""/>

      <protectedslots title=""/>

      <privateslots title=""/>

      <events title=""/>

      <properties title=""/>

      <friends title=""/>

    </memberdef>

    <authorsection visible="yes"/>

  </group>



  <!-- Layout definition for a directory page -->

  <directory>

    <briefdescription visible="yes"/>

    <directorygraph visible="yes"/>

    <memberdecl>

      <dirs visible="yes"/>

      <files visible="yes"/>

    </memberdecl>

    <detaileddescription title=""/>

  </directory>

</doxygenlayout>