summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-04-27 19:02:44 (GMT)
committerBrad King <brad.king@kitware.com>2022-04-28 17:36:20 (GMT)
commit4cb616fed63a93547e81812980d59660bdf9757f (patch)
treed51bd474bd7efcd166a856d2f887c37ec8f58cb0 /Help
parent37fb70591ebd06d8434eb7a650aeaae17b2380e2 (diff)
downloadCMake-4cb616fed63a93547e81812980d59660bdf9757f.zip
CMake-4cb616fed63a93547e81812980d59660bdf9757f.tar.gz
CMake-4cb616fed63a93547e81812980d59660bdf9757f.tar.bz2
Tutorial: Provide a source archive when published on cmake.org
Provide readers following the tutorial on `cmake.org` a direct link to download the tutorial's source examples. Previously readers had to fetch the CMake source tree separately and look for the tutorial source examples inside it. Fixes: #22475
Diffstat (limited to 'Help')
-rw-r--r--Help/guide/tutorial/index.rst5
-rw-r--r--Help/guide/tutorial/source.txt3
2 files changed, 6 insertions, 2 deletions
diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst
index 8b20a2d..09553cb 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 for examples can be found in
-the ``Help/guide/tutorial`` directory of the CMake source code tree.
+.. include:: source.txt
+
+|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/Help/guide/tutorial/source.txt b/Help/guide/tutorial/source.txt
new file mode 100644
index 0000000..bb45e86
--- /dev/null
+++ b/Help/guide/tutorial/source.txt
@@ -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.