diff --git a/Help/guide/tutorial/include/source.rst b/Help/guide/tutorial/include/source.rst new file mode 100644 index 0000000000..bb45e86c8d --- /dev/null +++ b/Help/guide/tutorial/include/source.rst @@ -0,0 +1,3 @@ +.. |tutorial_source| replace:: + The tutorial documentation and source code examples can be found in + the ``Help/guide/tutorial`` directory of the CMake source code tree. diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst index adedbcd1c3..438f368f67 100644 --- a/Help/guide/tutorial/index.rst +++ b/Help/guide/tutorial/index.rst @@ -11,8 +11,9 @@ work together in an example project can be very helpful. Steps ===== -The tutorial documentation and source code examples can be found in -the ``Help/guide/tutorial`` directory of the CMake source code tree. +.. include:: include/source.rst + +|tutorial_source| Each step has its own subdirectory containing code that may be used as a starting point. The tutorial examples are progressive so that each step provides the complete solution for the previous step. diff --git a/Utilities/Sphinx/tutorial_archive.cmake b/Utilities/Sphinx/tutorial_archive.cmake index 212a6220e7..4788a43436 100644 --- a/Utilities/Sphinx/tutorial_archive.cmake +++ b/Utilities/Sphinx/tutorial_archive.cmake @@ -14,7 +14,7 @@ file(COPY "${help_dir}/guide/tutorial/" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/${archive_name}" NO_SOURCE_PERMISSIONS PATTERN *.rst EXCLUDE - PATTERN source.txt EXCLUDE + REGEX "/guide/tutorial/include$" EXCLUDE ) file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/${archive_name}/README.txt" [[ This directory contains source code examples for the CMake Tutorial. @@ -32,11 +32,11 @@ file(ARCHIVE_CREATE ) # Write a reStructuredText snippet included from the tutorial index. -file(WRITE "${help_dir}/guide/tutorial/source.txt" " +file(WRITE "${help_dir}/guide/tutorial/include/source.rst" [[ .. |tutorial_source| replace:: The tutorial source code examples are available in - :download:`this archive `. -") + :download:`this archive `. +]]) # Remove temporary directory. file(REMOVE_RECURSE "${CMAKE_CURRENT_BINARY_DIR}/${archive_name}")