From 357bee25ff612b99cf8e694899e54f5d3153aebb Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Wed, 8 Nov 2023 15:38:31 -0500 Subject: [PATCH 1/2] DOC: Integrate supported compiler docs into sphinx Also heading correction. --- Documentation/docs/index.md | 1 + .../supported_compilers.md} | 18 ++++++++++++------ 2 files changed, 13 insertions(+), 6 deletions(-) rename Documentation/{SupportedCompilers.md => docs/supported_compilers.md} (86%) diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md index c78d5b5bf69..0c315e16922 100644 --- a/Documentation/docs/index.md +++ b/Documentation/docs/index.md @@ -42,6 +42,7 @@ API Discussion Issue tracker CDash Dashboard +supported_compilers releases/index migration_guides/index contributing/code_of_conduct diff --git a/Documentation/SupportedCompilers.md b/Documentation/docs/supported_compilers.md similarity index 86% rename from Documentation/SupportedCompilers.md rename to Documentation/docs/supported_compilers.md index ea7cf6ada0a..6c0fce8d223 100644 --- a/Documentation/SupportedCompilers.md +++ b/Documentation/docs/supported_compilers.md @@ -1,23 +1,29 @@ +# Supported Compilers + ITK requires a compiler with C++17 support. -# Visual Studio +## Visual Studio + * VS2017 and earlier: **NOT supported** * MSVC toolset v142 (first shipped with VS2019): supported * MSVC toolset v143 (first shipped with VS2022): supported -# GNU Compile Collection +## GNU Compile Collection + * GCC 7 and later [should be supported](https://www.gnu.org/software/gcc/projects/cxx-status.html). -# LLVM Clang +## LLVM Clang + * Clang 5 and later [should be supported](https://clang.llvm.org/cxx_status.html) -# AppleClang +## AppleClang * AppleClang 10.0.0 and later (from Xcode 10.0) [should be supported](https://en.wikipedia.org/wiki/Xcode#Version_history) -# Intel C++ Compiler +## Intel C++ Compiler * Intel C++ 19.1 and later -# Future versions +## Future versions + Future versions of these compilers should be backwards compatible, and thus ITK is expected to work with them. In the near term, ITK should continue compiling with new compiler versions, probably with some warnings. Eventually, ITK will stop compiling with newest compiler versions. But upgrading to a newer version of ITK is recommended long before then! From feafcdbf9cdaa75f420ea2426ef636a42006be0e Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Wed, 8 Nov 2023 15:41:23 -0500 Subject: [PATCH 2/2] DOC: Add Releases and Licenses to Download section More balance to section content and add ITK Releases and ITK Software Licenses into the Download section, which is geared toward obtaining the software. --- Documentation/docs/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/docs/index.md b/Documentation/docs/index.md index 0c315e16922..d4974495f41 100644 --- a/Documentation/docs/index.md +++ b/Documentation/docs/index.md @@ -20,6 +20,8 @@ We invite you to join the ITK community and explore our documentation to find ou :caption: 💾 Download download +releases/index +licenses ``` @@ -43,9 +45,7 @@ Discussion Issue tracker CDash Dashboard supported_compilers -releases/index migration_guides/index contributing/code_of_conduct contributing/index -licenses ```