================
@@ -1,104 +1,103 @@
-==========================
-Sphinx Quickstart Template
-==========================
+# Sphinx Quickstart Template
This article is intended to take someone in the state of “I want to write
documentation and get it added to LLVM’s docs” and help them start writing
documentation as fast as possible and with as little nonsense as possible.
-.. contents::
- :local:
+```{contents}
+:local:
+```
-Overview
-========
+## Overview
-LLVM documentation is written in `reStructuredText`_, a markup syntax similar
to markdown (but much more powerful). The LLVM documentation site itself uses
`Sphinx`_, a documentation generator originally written for Python
documentation.
+LLVM documentation is written in [Markedly Structured Text (MyST)][myst] and
[reStructuredText (reST)][reStructuredText].
+MyST is a Markdown flavor that adds Sphinx documentation extensions.
+MyST is preferred for new docs, and migrating old docs from reST to MyST is an
open, ongoing project.
----------------
JDevlieghere wrote:
Once we've defined that MyST is a Markdown flavor, I'd use that as the
canonical way or referring to the format. That'd be consistent with the rest of
the document.
```suggestion
LLVM documentation is written in [Markedly Structured Text (MyST)][myst] and
[reStructuredText (reST)][reStructuredText].
MyST is a Markdown flavor that adds Sphinx documentation extensions.
Markdown is preferred for new docs, and migrating old docs from
reStructuredText to Markdown is an open, ongoing project.
```
https://github.com/llvm/llvm-project/pull/198896
_______________________________________________
llvm-branch-commits mailing list
[email protected]
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits
