diff --git a/documentation/source/readme/reStructuredText Basics.rst b/documentation/source/readme/reStructuredText Basics.rst index 4d024d52d9a964ea176395fa8159bf3d10ffcdec..a7c360390675fb8b111f245f7d5e1e57d8eaeafe 100644 --- a/documentation/source/readme/reStructuredText Basics.rst +++ b/documentation/source/readme/reStructuredText Basics.rst @@ -1,6 +1,6 @@ **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. +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. @@ -10,14 +10,14 @@ reStructuredText is useful for creating simple web pages, and for standalone doc ============================= 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. Some writers also prefer reStructuredText because the markup standards are more well-defined compared to markdown. +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. + +Some writers also prefer reStructuredText because the markup standards are more well-defined compared to markdown. **Project setup** ================= -1. **Installation** - -Open this link for complete installation process +Use this link for complete installation and authoring process `<https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html>`_ @@ -38,6 +38,7 @@ Inline markup for font styles is similar to markdown: Links to external sites contain the link text and a bracketed URL in backticks, followed by an underscore: Link to write the docs `<https://www.writethedocs.org/>`_ + **Headers** =========== @@ -57,23 +58,30 @@ Headers are demarcated by non-alphanumeric characters like dashes, equal signs, For creating list just place an asterisk(*) or hyphen (-) at the start of a paragraph and indent continuation lines with one space. The same goes for numbered lists; they can also be autonumbered using a (#) sign: +*example* + +.. figure:: Images/List.PNG + * This is a bulleted list. * It has two items too. -3. This is a numbered list. -4. It has two items too. +1. This is a numbered list. +2. It has two items too. #. This is a numbered list. #. It has two items too. -.. figure:: Image/List-table.PNG - **Multi-column lists** ====================== If you have a long bullet list of items, where each item is short, you can indicate the list items should be rendered in multiple columns with a special .. rst-class:: rst-columns directive. The directive will apply to the next non-comment element (e.g., paragraph), or to content indented under the directive. -For example, this unordered list: +*example* + + .. figure:: Images/multi-column_list.PNG + + +this unordered list: .. rst-class:: rst-columns @@ -89,32 +97,20 @@ For example, this unordered list: **Images** ========== -reSt supports an image directive, used like: .. image:: gnu.png +reSt supports an image directive, used like: .. figure:: Images/image name.PNG *example* -.. figure:: /images/muti data.png + .. figure:: Images/multi_data.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. - -First we need to give colon (..) give one space then write toctree and close it with colon again. - -Next step enter space three times then give colon and enter maxdepth close it with colon again. - -last step is enter space three times and write reference files names. - *example* -.. toctree:: - :maxdepth: 1 - - filename 1 - filename 2 - + .. figure:: Images/toctree.PNG **List Table** ============== @@ -123,6 +119,9 @@ The "list-table" directive is used to create a table from data in a uniform two- *Example* + .. figure:: Images/List-table.PNG + + .. list-table:: Frozen Delights! :widths: 15 10 30 :header-rows: 1 @@ -144,12 +143,15 @@ The "list-table" directive is used to create a table from data in a uniform two- **CSV table** ============= -The "csv-table" directive is used to create a table from CSV (comma-separated values) data. CSV is a common data format generated by spreadsheet applications and commercial databases. +The "CSV-table" directive is used to create a table from CSV (comma-separated values) data. CSV is a common data format generated by spreadsheet applications and commercial databases. The data may be internal (an integral part of the document) or external (a separate file). *Example* + + .. figure:: Images/ csv_table.PNG + .. csv-table:: Frozen Delights! :header: "Treat", "Quantity", "Description" @@ -165,10 +167,13 @@ The data may be internal (an integral part of the document) or external (a separ **Cross-referencing syntax** -Basically, you only need to write :role:`target` and a link will be created to the item named target of the type indicated by role +Basically, you only need to write :role:`target` and a link will be created to the item named target of the type indicated by role. **math** + .. figure:: Images/math.PNG + + Since Pythagoras, we know that :math:`a^2 + b^2 = c^2` we know that, algebric formula