[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.
This commit is contained in:
parent
246c752ef1
commit
c42ce32264
17 changed files with 21 additions and 18 deletions
|
|
@ -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()
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ from datetime import date
|
|||
|
||||
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 -----------------------------------------------------
|
||||
|
||||
|
|
|
|||
|
|
@ -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 @@ private:
|
|||
|
||||
/// 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 @@ private:
|
|||
};
|
||||
|
||||
/// 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 @@ protected:
|
|||
};
|
||||
|
||||
/// "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 @@ private:
|
|||
};
|
||||
|
||||
/// 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.
|
||||
|
|
|
|||
|
|
@ -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")
|
||||
|
|
|
|||
|
|
@ -13,7 +13,11 @@ author = "LLVM project"
|
|||
# -- 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 = []
|
||||
|
|
|
|||
Loading…
Reference in a new issue