DOC: Update notes for ITKExamples -> ITKSphinxExamples repository ren…

…aming
InsightSoftwareConsortium · Mar 17, 2021 · bf7600b · bf7600b
1 parent 46f9452
commit bf7600b
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 16 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -34,7 +34,7 @@ of the person or team responsible for reviewing proposed changes. -->
 - [ ] Updated API documentation (or API not changed)
 - [ ] Added [license](https://github.com/InsightSoftwareConsortium/ITK/blob/master/Utilities/KWStyle/ITKHeader.h) to new files (if any)
 - [ ] Added Python wrapping to new files (if any) as described in [ITK Software Guide](https://itk.org/ItkSoftwareGuide.pdf) Section 9.5
-- [ ] Added [ITK examples](https://github.com/InsightSoftwareConsortium/ITKExamples) for all new major features (if any)
+- [ ] Added [ITK examples](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples) for all new major features (if any)
 
 Refer to the [ITK Software Guide](https://itk.org/ItkSoftwareGuide.pdf) for
 further development details if necessary.

diff --git a/Documentation/Maintenance/Release.md b/Documentation/Maintenance/Release.md
@@ -529,16 +529,16 @@ Next, [upload the wheels to the Python Package Index
 ### Verify the binaries
 
 Run `pip install itk` in a fresh virtualenv and run all the
-[ITKExamples](https://github.com/InsightSoftwareConsortium/ITKExamples) Python
+[ITKSphinxExamples](https://github.com/InsightSoftwareConsortium/ITKSphinxExamples) Python
 tests against this Python. For example,
 
 ```sh
 virtualenv itk-venv
 ./itk-venv/bin/python -m pip install itk
-git clone https://github.com/InsightSoftwareConsortium/ITKExamples
-mkdir ITKExamples-build
-cd ITKExamples-build
-cmake -DITK_DIR=/path/to/ITK-build -DPython3_ROOT_DIR=../itk-venv -DPython3_FIND_VIRTUALENV=ONLY -DPYTHON_EXECUTABLE=../itk-venv/bin/python3 ../ITKExamples
+git clone https://github.com/InsightSoftwareConsortium/ITKSphinxExamples
+mkdir ITKSphinxExamples-build
+cd ITKSphinxExamples-build
+cmake -DITK_DIR=/path/to/ITK-build -DPython3_ROOT_DIR=../itk-venv -DPython3_FIND_VIRTUALENV=ONLY -DPYTHON_EXECUTABLE=../itk-venv/bin/python3 ../ITKSphinxExamples
 ctest -R Python
 ```
 

diff --git a/Documentation/UploadBinaryData.md b/Documentation/UploadBinaryData.md
@@ -171,7 +171,7 @@ actual file is desired in the build tree. Stage the new file to your commit:
 [hashsum_download]: https://girder.readthedocs.io/en/latest/plugins.html#hashsum-download
 [ITK collection]: https://data.kitware.com/#collection/57b5c9e58d777f126827f5a1
 [ITK community]: https://discourse.itk.org/
-[ITK Examples]: https://itk.org/ITKExamples/index.html
+[ITK Sphinx Examples]: https://itk.org/ITKExamples/index.html
 [ITK Software Guide]: https://itk.org/ItkSoftwareGuide.pdf
 [solution to this problem]: https://blog.kitware.com/cmake-externaldata-using-large-files-with-distributed-version-control/
 [UploadBinaryData.sh]: ../Utilities/UploadBinaryData.sh

diff --git a/Examples/README.md b/Examples/README.md
@@ -1,12 +1,12 @@
-ITK Examples Directory
-----------------------
+ITK Software Guide Examples
+---------------------------
 
 This directory contains simple, companion examples to the ITK Software Guide.
 These examples are designed to demonstrate features of the system; they are not
 meant to be significant applications of the software.
 
 For a more comprehensive set of self-contained, illustrative examples, see the
-[ITKExamples](https://itk.org/ITKExamples).
+[ITKSphinxExamples](https://itk.org/ITKExamples).
 
 Specifically, the purpose of these examples is as follows:
 

diff --git a/Modules/Remote/SphinxExamples.remote.cmake b/Modules/Remote/SphinxExamples.remote.cmake
@@ -49,6 +49,6 @@
 itk_fetch_module(SphinxExamples
   "This module builds the examples found at https://itk.org/ITKExamples/"
   MODULE_COMPLIANCE_LEVEL 5
-  GIT_REPOSITORY ${git_protocol}://github.com/InsightSoftwareConsortium/ITKExamples.git
+  GIT_REPOSITORY ${git_protocol}://github.com/InsightSoftwareConsortium/ITKSphinxExamples.git
   GIT_TAG cb1b6e7c73947cdce888f80ff2ba2e23d6155d78
   )
diff --git a/Utilities/Maintenance/AuthorsChangesSince.py b/Utilities/Maintenance/AuthorsChangesSince.py
@@ -243,19 +243,19 @@ def write_changelog(repo_name, commit_link_prefix, git_revision):
 commit_link_prefix = "https://github.com/InsightSoftwareConsortium/ITK/commit/"
 write_changelog("ITK", commit_link_prefix, revision + "..")
 
-# ITKExamples Repository
+# ITKSphinxExamples Repository
 os.chdir(scratch_dir)
-examples_dir = scratch_dir / "ITKExamples"
+examples_dir = scratch_dir / "ITKSphinxExamples"
 if not examples_dir.exists():
     subprocess.check_call(
-        "git clone https://github.com/InsightSoftwareConsortium/ITKExamples", shell=True
+        "git clone https://github.com/InsightSoftwareConsortium/ITKSphinxExamples", shell=True
     )
 os.chdir(examples_dir)
 update_previous_authors(f'--until="{revision_time}"')
 update_recent_authors(f'--since="{revision_time}"')
 update_authors_with_email(f'--since="{revision_time}"')
-commit_link_prefix = "https://github.com/InsightSoftwareConsortium/ITKExamples/commit/"
-write_changelog("ITK Examples", commit_link_prefix, f'--since="{revision_time}"')
+commit_link_prefix = "https://github.com/InsightSoftwareConsortium/ITKSphinxExamples/commit/"
+write_changelog("ITK Sphinx Examples", commit_link_prefix, f'--since="{revision_time}"')
 
 # ITKSoftwareGuide Repository
 os.chdir(scratch_dir)