From 8af23440520b1938e4354ce760699abb3ac30cc2 Mon Sep 17 00:00:00 2001 From: Gururaj Shetty <gururaj.shetty@huawei.com> Date: Tue, 5 Jan 2021 06:24:00 +0000 Subject: [PATCH] Update documentation/source/readme/reStructuredText Basics.rst --- documentation/source/readme/reStructuredText Basics.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/source/readme/reStructuredText Basics.rst b/documentation/source/readme/reStructuredText Basics.rst index c121f50..6421a87 100644 --- a/documentation/source/readme/reStructuredText Basics.rst +++ b/documentation/source/readme/reStructuredText Basics.rst @@ -1,3 +1,4 @@ + What is reStructuredText? ============================= reStructuredText is an easy to read, what-you-see-is-what-you-get plainttext markup syntax and parser system. In other words reStructuredText is a lightweight markup language that is used in static site generators like Sphinx. @@ -6,7 +7,7 @@ It contains robust tools for semantic markup, reusing content, and content filte reStructuredText is useful for creating simple web pages, and for standalone documents. -**Why use reStructuredText?** +Why use reStructuredText? ============================= reStructuredText is a lightweight markup language, so it’s easier to read in plain-text format compared to heavier markup languages like DITA and other XML-based formats. @@ -14,13 +15,13 @@ You can easily find text editors that render reStructuredText with syntax highli Some writers also prefer reStructuredText because the markup standards are more well-defined compared to markdown. -**Project setup** +Project setup ================= For complete setup of Sphinx and its installation process, refer `<https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html>`_. -**How to use reStructuredText** +How to use reStructuredText =============================== *Formatting the main text* -- GitLab