Commit 98177777 authored by Jakub Klinkovský's avatar Jakub Klinkovský Committed by Tomáš Oberhuber
Browse files

Fixed building documentation with code and output snippets

parent 10d646e6

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ 
/Release

/Testing

/Documentation/html/

/Documentation/output_snippets/

/CMakeLists.txt.user

/Build

/coverage_report

.gitlab-ci.yml

+9 −1
Original line number Diff line number Diff line
@@ -12,6 +12,7 @@ before_script: 
# same job.

stages:

    - build

    - doc_build

    - deploy



# default flags for cmake
@@ -134,6 +135,10 @@ cuda_examples_Debug: 
        WITH_CUDA: "yes"

        BUILD_TYPE: Debug

        WITH_EXAMPLES: "yes"

    # store output snippets for documentation

    artifacts:

        paths:

            - Documentation/output_snippets/



cuda_examples_Release:

    <<: *build_template
@@ -398,12 +403,15 @@ mpi_benchmarks_tools_python_Release: 




build documentation:

    stage: build

    stage: doc_build

    only:

        changes:

            - Documentation/**/*

            - src/TNL/**/*.{h,hpp}

            - .gitlab-ci.yml

    dependencies:

        # the job which builds Documentation/output_snippets/

        - cuda_examples_Debug

    script:

        - ./Documentation/build

    artifacts:

CMakeLists.txt

+6 −14
Original line number Diff line number Diff line
@@ -316,19 +316,11 @@ LINK_DIRECTORIES( ${LIBRARY_OUTPUT_PATH} ) 
add_subdirectory( src )

add_subdirectory( share )



# FIXME !!!

#Check for Doxygen

#if( ${WITH_DOC} )

#    find_package(Doxygen)

#    if( DOXYGEN_FOUND )

#        if( CMAKE_BUILD_TYPE MATCHES "Release" )

#            add_subdirectory( Documentation/Tutorials )

#        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} )

if( ${WITH_EXAMPLES} )

# Add subdirectories for examples included in the documentation

if( ${WITH_DOC} OR ${WITH_EXAMPLES} )

   set( TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH "${CMAKE_SOURCE_DIR}/Documentation/output_snippets" )

   file(MAKE_DIRECTORY ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH})

   add_subdirectory( Documentation/Examples )

   add_subdirectory( Documentation/Tutorials )

endif()

Documentation/Doxyfile

+3 −5
Original line number Diff line number Diff line
@@ -744,7 +744,7 @@ WARNINGS = YES 
# will automatically be disabled.

# The default value is: YES.



WARN_IF_UNDOCUMENTED   = YES

WARN_IF_UNDOCUMENTED   = NO



# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for

# potential errors in the documentation, such as not documenting some parameters
@@ -923,11 +923,9 @@ EXCLUDE_SYMBOLS += TNL::Assert::* # internal namespace 
# that contain example code fragments that are included (see the \include

# command).



EXAMPLE_PATH += ../src/Examples

EXAMPLE_PATH += Examples

EXAMPLE_PATH += Tutorials

# directories for output snippets

EXAMPLE_PATH += ../Release/Documentation/Tutorials

EXAMPLE_PATH += ../Debug/Documentation/Tutorials

EXAMPLE_PATH += output_snippets



# 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

Documentation/Examples/CMakeLists.txt

0 → 100644
+76 −0
Original line number Diff line number Diff line 
ADD_SUBDIRECTORY( Containers )



ADD_EXECUTABLE( FileExample FileExample.cpp )

ADD_CUSTOM_COMMAND( COMMAND FileExample > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileExample.out OUTPUT FileExample.out )



IF( BUILD_CUDA )

   CUDA_ADD_EXECUTABLE(FileExampleCuda FileExampleCuda.cu)

   ADD_CUSTOM_COMMAND( COMMAND FileExampleCuda > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileExampleCuda.out OUTPUT FileExampleCuda.out )

ENDIF()



ADD_EXECUTABLE( FileExampleSaveAndLoad FileExampleSaveAndLoad.cpp )

ADD_CUSTOM_COMMAND( COMMAND FileExampleSaveAndLoad > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileExampleSaveAndLoad.out OUTPUT FileExampleSaveAndLoad.out )



ADD_EXECUTABLE( FileNameExample FileNameExample.cpp )

ADD_CUSTOM_COMMAND( COMMAND FileNameExample > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileNameExample.out OUTPUT FileNameExample.out )



ADD_EXECUTABLE( FileNameExampleDistributedSystemNodeCoordinates FileNameExampleDistributedSystemNodeCoordinates.cpp )

ADD_CUSTOM_COMMAND( COMMAND FileNameExampleDistributedSystemNodeCoordinates > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileNameExampleDistributedSystemNodeCoordinates.out OUTPUT FileNameExampleDistributedSystemNodeCoordinates.out )





ADD_EXECUTABLE( FileNameExampleDistributedSystemNodeId FileNameExampleDistributedSystemNodeId.cpp )

ADD_CUSTOM_COMMAND( COMMAND FileNameExampleDistributedSystemNodeId > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/FileNameExampleDistributedSystemNodeId.out OUTPUT FileNameExampleDistributedSystemNodeId.out )



ADD_EXECUTABLE( ObjectExample_getType ObjectExample_getType.cpp )

ADD_CUSTOM_COMMAND( COMMAND ObjectExample_getType > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/ObjectExample_getType.out OUTPUT ObjectExample_getType.out )



ADD_EXECUTABLE( ParameterContainerExample ParameterContainerExample.cpp )



ADD_EXECUTABLE( ParseObjectTypeExample ParseObjectTypeExample.cpp )

ADD_CUSTOM_COMMAND( COMMAND ParseObjectTypeExample > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/ParseObjectTypeExample.out OUTPUT ParseObjectTypeExample.out )



ADD_EXECUTABLE( StringExample StringExample.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExample > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExample.out OUTPUT StringExample.out )



ADD_EXECUTABLE( StringExampleGetAllocatedSize StringExampleGetAllocatedSize.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExampleGetAllocatedSize > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExampleGetAllocatedSize.out OUTPUT StringExampleGetAllocatedSize.out )



ADD_EXECUTABLE( StringExampleReplace StringExampleReplace.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExampleReplace > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExampleReplace.out OUTPUT StringExampleReplace.out )



ADD_EXECUTABLE( StringExampleSetSize StringExampleSetSize.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExampleSetSize > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExampleSetSize.out OUTPUT StringExampleSetSize.out )



ADD_EXECUTABLE( StringExampleSplit StringExampleSplit.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExampleSplit > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExampleSplit.out OUTPUT StringExampleSplit.out )



ADD_EXECUTABLE( StringExampleStrip StringExampleStrip.cpp )

ADD_CUSTOM_COMMAND( COMMAND StringExampleStrip > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/StringExampleStrip.out OUTPUT StringExampleStrip.out )



ADD_EXECUTABLE( TimerExample TimerExample.cpp )

ADD_CUSTOM_COMMAND( COMMAND TimerExample > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/TimerExample.out OUTPUT TimerExample.out )



ADD_EXECUTABLE( TimerExampleLogger TimerExampleLogger.cpp )

ADD_CUSTOM_COMMAND( COMMAND TimerExampleLogger > ${TNL_DOCUMENTATION_OUTPUT_SNIPPETS_PATH}/TimerExampleLogger.out OUTPUT TimerExampleLogger.out )





ADD_CUSTOM_TARGET( RunExamples ALL DEPENDS

   FileExample.out

   FileExampleSaveAndLoad.out

   FileNameExample.out

   FileNameExampleDistributedSystemNodeCoordinates.out

   FileNameExampleDistributedSystemNodeId.out

   ObjectExample_getType.out

   ParseObjectTypeExample.out

   StringExample.out

   StringExampleGetAllocatedSize.out

   StringExampleReplace.out

   StringExampleSplit.out

   StringExampleStrip.out

   TimerExample.out

   TimerExampleLogger.out )



if( BUILD_CUDA )

   ADD_CUSTOM_TARGET( RunExamples-cuda ALL DEPENDS

      FileExampleCuda.out )

ENDIF()