Author: Reid Kleckner Date: 2026-07-17T10:48:13-07:00 New Revision: c42ce32264f94a8800f4250d7b716cca55f77df6
URL: https://github.com/llvm/llvm-project/commit/c42ce32264f94a8800f4250d7b716cca55f77df6 DIFF: https://github.com/llvm/llvm-project/commit/c42ce32264f94a8800f4250d7b716cca55f77df6.diff LOG: [docs] Rename misc rst docs to md (#210208) Tracking issue: #201242 See the [migration guide] for more information. [migration guide]: https://llvm.org/docs/SphinxQuickstartTemplate.html#markdown-migration-guidelines This is the initial straight rename commit. Many of these miscellaneous .rst files are not actually part of a real docs build, since docs/conf.py does not exist for many of them. Added: compiler-rt/docs/ASanABI.md compiler-rt/docs/BuildingCompilerRT.md compiler-rt/docs/TestingGuide.md flang/docs/CommandGuide/index.md libsycl/docs/CodingGuidelines.md libsycl/docs/index.md libunwind/docs/BuildingLibunwind.md libunwind/docs/index.md lldb/source/Plugins/TraceExporter/docs/htr.md llvm-libgcc/docs/LLVMLibgcc.md offload/docs/index.md Modified: flang/docs/CMakeLists.txt libsycl/test/README.md libunwind/docs/conf.py lldb/source/Plugins/TraceExporter/common/TraceHTR.h llvm-libgcc/generate_version_script.py offload/docs/conf.py Removed: compiler-rt/docs/ASanABI.rst compiler-rt/docs/BuildingCompilerRT.rst compiler-rt/docs/TestingGuide.rst flang/docs/CommandGuide/index.rst libsycl/docs/CodingGuidelines.rst libsycl/docs/index.rst libunwind/docs/BuildingLibunwind.rst libunwind/docs/index.rst lldb/source/Plugins/TraceExporter/docs/htr.rst llvm-libgcc/docs/LLVMLibgcc.rst offload/docs/index.rst ################################################################################ diff --git a/compiler-rt/docs/ASanABI.rst b/compiler-rt/docs/ASanABI.md similarity index 100% rename from compiler-rt/docs/ASanABI.rst rename to compiler-rt/docs/ASanABI.md diff --git a/compiler-rt/docs/BuildingCompilerRT.rst b/compiler-rt/docs/BuildingCompilerRT.md similarity index 100% rename from compiler-rt/docs/BuildingCompilerRT.rst rename to compiler-rt/docs/BuildingCompilerRT.md diff --git a/compiler-rt/docs/TestingGuide.rst b/compiler-rt/docs/TestingGuide.md similarity index 100% rename from compiler-rt/docs/TestingGuide.rst rename to compiler-rt/docs/TestingGuide.md diff --git a/flang/docs/CMakeLists.txt b/flang/docs/CMakeLists.txt index d23cb7ea8c586..ddf3fb4543b6f 100644 --- a/flang/docs/CMakeLists.txt +++ b/flang/docs/CMakeLists.txt @@ -113,14 +113,14 @@ if (LLVM_ENABLE_SPHINX) message(STATUS "Using index.md for html build") # Copy the entire flang/docs directory to the build Source dir, - # then remove the index.rst file, to avoid clash with index.md + # then remove the CommandGuide index.md file, to avoid clash with index.md # which is used for the HTML build. add_custom_target(copy-flang-src-docs-html COMMAND "${CMAKE_COMMAND}" -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}" "${FLANG_DOCS_HTML_DIR}" COMMAND "${CMAKE_COMMAND}" -E remove - "${FLANG_DOCS_HTML_DIR}/CommandGuide/index.rst" + "${FLANG_DOCS_HTML_DIR}/CommandGuide/index.md" COMMAND "${CMAKE_COMMAND}" -E copy "${CMAKE_CURRENT_BINARY_DIR}/Source/FlangCommandLineReference.rst" "${FLANG_DOCS_HTML_DIR}/FlangCommandLineReference.rst" @@ -145,11 +145,11 @@ if (LLVM_ENABLE_SPHINX) # MAN BUILD SETUP # ---------------------------- if (${SPHINX_OUTPUT_MAN}) - message(STATUS "Using CommandGuide/index.rst for man build") + message(STATUS "Using CommandGuide/index.md for man build") # Create minimal Source dir with ONLY the files needed for man build: # - conf.py (Sphinx config) - # - index.rst (top-level man page) + # - index.md (top-level man page) # - FlangCommandLineOptions.rst (generated reference) add_custom_target(copy-flang-src-docs-man COMMAND "${CMAKE_COMMAND}" -E make_directory @@ -161,8 +161,8 @@ if (LLVM_ENABLE_SPHINX) "${CMAKE_CURRENT_BINARY_DIR}/Source/FlangCommandLineOptions.rst" "${FLANG_DOCS_MAN_DIR}/FlangCommandLineOptions.rst" COMMAND "${CMAKE_COMMAND}" -E copy - "${CMAKE_CURRENT_SOURCE_DIR}/CommandGuide/index.rst" - "${FLANG_DOCS_MAN_DIR}/index.rst" + "${CMAKE_CURRENT_SOURCE_DIR}/CommandGuide/index.md" + "${FLANG_DOCS_MAN_DIR}/index.md" DEPENDS flang-doc gen-FlangCommandLineOptions.rst) add_sphinx_target(man flang SOURCE_DIR "${FLANG_DOCS_MAN_DIR}") @@ -170,4 +170,3 @@ if (LLVM_ENABLE_SPHINX) endif() endif() endif() - diff --git a/flang/docs/CommandGuide/index.rst b/flang/docs/CommandGuide/index.md similarity index 100% rename from flang/docs/CommandGuide/index.rst rename to flang/docs/CommandGuide/index.md diff --git a/libsycl/docs/CodingGuidelines.rst b/libsycl/docs/CodingGuidelines.md similarity index 100% rename from libsycl/docs/CodingGuidelines.rst rename to libsycl/docs/CodingGuidelines.md diff --git a/libsycl/docs/index.rst b/libsycl/docs/index.md similarity index 100% rename from libsycl/docs/index.rst rename to libsycl/docs/index.md diff --git a/libsycl/test/README.md b/libsycl/test/README.md index 7ee8899012eeb..9833c62f1fb5c 100644 --- a/libsycl/test/README.md +++ b/libsycl/test/README.md @@ -11,7 +11,7 @@ for more information about LIT. * Target runtime(s) to execute tests on devices. TODO: add link to liboffload instruction once they add it. * Compiler & libsycl. Can be built following these - [instructions](/libsycl/docs/index.rst). + [instructions](/libsycl/docs/index.md). ## Run the tests diff --git a/libunwind/docs/BuildingLibunwind.rst b/libunwind/docs/BuildingLibunwind.md similarity index 100% rename from libunwind/docs/BuildingLibunwind.rst rename to libunwind/docs/BuildingLibunwind.md diff --git a/libunwind/docs/conf.py b/libunwind/docs/conf.py index 2d91df6753d69..354192815a1aa 100644 --- a/libunwind/docs/conf.py +++ b/libunwind/docs/conf.py @@ -15,7 +15,7 @@ from llvm_sphinx import * # see llvm-project/utils/docs/README.md -globals().update(common_conf(tags, markdown=Markdown.NEVER)) +globals().update(common_conf(tags)) # -- General configuration ----------------------------------------------------- diff --git a/libunwind/docs/index.rst b/libunwind/docs/index.md similarity index 100% rename from libunwind/docs/index.rst rename to libunwind/docs/index.md diff --git a/lldb/source/Plugins/TraceExporter/common/TraceHTR.h b/lldb/source/Plugins/TraceExporter/common/TraceHTR.h index 4ef3ff295cc09..152b30b35a190 100644 --- a/lldb/source/Plugins/TraceExporter/common/TraceHTR.h +++ b/lldb/source/Plugins/TraceExporter/common/TraceHTR.h @@ -19,7 +19,7 @@ namespace lldb_private { /// Metadata associated with an HTR block -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class HTRBlockMetadata { public: /// Constructor for a block's metadata. @@ -87,7 +87,7 @@ class HTRBlockMetadata { /// Block structure representing a sequence of trace "units" (ie instructions). /// Sequences of blocks are merged to create a new, single block -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class HTRBlock { public: /// Constructor for a block of an HTR layer. @@ -134,7 +134,7 @@ class HTRBlock { }; /// HTR layer interface -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class IHTRLayer { public: /// Construct new HTR layer. @@ -189,7 +189,7 @@ class IHTRLayer { }; /// "Base" layer of HTR representing the dynamic instructions of the trace. -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class HTRInstructionLayer : public IHTRLayer { public: /// Construct new instruction layer. @@ -240,7 +240,7 @@ class HTRInstructionLayer : public IHTRLayer { }; /// HTR layer composed of blocks of the trace. -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class HTRBlockLayer : public IHTRLayer { public: /// Construct new block layer. @@ -301,7 +301,7 @@ typedef std::unique_ptr<lldb_private::HTRInstructionLayer> HTRInstructionLayerUP; /// Top-level HTR class -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation class TraceHTR { public: @@ -394,7 +394,7 @@ llvm::json::Value toJSON(const HTRBlockMetadata &metadata); /// ends with the tail block and the next group begins with the /// following block. /// -/// See lldb/docs/htr.rst for comprehensive HTR documentation +/// See lldb/docs/htr.md for comprehensive HTR documentation /// /// \param[in] layer /// The layer to execute the pass on. diff --git a/lldb/source/Plugins/TraceExporter/docs/htr.rst b/lldb/source/Plugins/TraceExporter/docs/htr.md similarity index 100% rename from lldb/source/Plugins/TraceExporter/docs/htr.rst rename to lldb/source/Plugins/TraceExporter/docs/htr.md diff --git a/llvm-libgcc/docs/LLVMLibgcc.rst b/llvm-libgcc/docs/LLVMLibgcc.md similarity index 100% rename from llvm-libgcc/docs/LLVMLibgcc.rst rename to llvm-libgcc/docs/LLVMLibgcc.md diff --git a/llvm-libgcc/generate_version_script.py b/llvm-libgcc/generate_version_script.py index 5332869494a35..a6f22e91e74a0 100755 --- a/llvm-libgcc/generate_version_script.py +++ b/llvm-libgcc/generate_version_script.py @@ -86,7 +86,7 @@ def to_file(versioned_symbols): "Do not check this version script in: you should instead work " "out which symbols are missing in `lib/gcc_s.ver` and then " "integrate them into `lib/gcc_s.ver`. For more information, " - "please see `doc/LLVMLibgcc.rst`.\n" + "please see `doc/LLVMLibgcc.md`.\n" ) for version, symbols in versioned_symbols: f.write(f"{version} {{\n") diff --git a/offload/docs/conf.py b/offload/docs/conf.py index 08a991a7d5ad5..ca6ec5b8039c0 100644 --- a/offload/docs/conf.py +++ b/offload/docs/conf.py @@ -13,7 +13,11 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = ["myst_parser"] +source_suffix = { + ".rst": "restructuredtext", + ".md": "markdown", +} templates_path = ["_templates"] exclude_patterns = [] diff --git a/offload/docs/index.rst b/offload/docs/index.md similarity index 100% rename from offload/docs/index.rst rename to offload/docs/index.md _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
