From 6d147683c794597b52dece91584b28b5891fb72d Mon Sep 17 00:00:00 2001 From: Gururaj Shetty <gururaj.shetty@huawei.com> Date: Tue, 5 Jan 2021 06:28:12 +0000 Subject: [PATCH] Update reStructuredText Basics.rst --- documentation/source/readme/reStructuredText Basics.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/source/readme/reStructuredText Basics.rst b/documentation/source/readme/reStructuredText Basics.rst index 23718df..04e4018 100644 --- a/documentation/source/readme/reStructuredText Basics.rst +++ b/documentation/source/readme/reStructuredText Basics.rst @@ -1,6 +1,7 @@ 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. It contains robust tools for semantic markup, reusing content, and content filters for different kinds of outputs. It’s also easily extendible using custom directives that you can create yourself, allowing you to satisfy a wide variety of documentation needs. @@ -9,6 +10,7 @@ reStructuredText is useful for creating simple web pages, and for standalone doc 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. You can easily find text editors that render reStructuredText with syntax highlighting and live previews, without having to invest in complex tools. Compared to some other lightweight markup languages like markdown, reStructuredText contains stronger semantic markup tools. @@ -129,6 +131,7 @@ this unordered list: Images ========== + reSt supports an image directive, used like: .. figure:: Images/image name.PNG *example* @@ -138,6 +141,7 @@ reSt supports an image directive, used like: .. figure:: Images/image name.PNG Directives ============== + Directive is a generic block of explicit markup. While docutils provides a number of directives, sphinx provides many more and uses directives as one of the primary extension mechanism. *example* -- GitLab