Skip to content
Snippets Groups Projects
Commit 6dc1bad0 authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

Update documentation/source/readme/reStructuredText Basics.rst

parent 8af23440
No related branches found
No related tags found
No related merge requests found
......@@ -24,7 +24,7 @@ For complete setup of Sphinx and its installation process, refer `<https://sphin
How to use reStructuredText
===============================
*Formatting the main text*
Formatting the main text
--------------------------
Paragraphs in reStructuredText are blocks of text separated by at least one blank line. All lines in the paragraph must be indented by the same amount.
......@@ -47,8 +47,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**
Headers
===========
Headers are demarcated by non-alphanumeric characters like dashes, equal signs, or tildes. Use the same character for headers at the same level. The following creates a header:
......@@ -99,7 +98,7 @@ For creating list just place an asterisk(*) or hyphen (-) at the start of a para
#. This is a numbered list.
#. It has two items too.
**Multi-column lists**
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.
......@@ -128,7 +127,7 @@ this unordered list:
* Use up so much
**Images**
Images
==========
reSt supports an image directive, used like: .. figure:: Images/image name.PNG
......@@ -137,7 +136,7 @@ reSt supports an image directive, used like: .. figure:: Images/image name.PNG
.. figure:: Images/multi_data.PNG
**Directives**
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.
......@@ -152,7 +151,7 @@ Directive is a generic block of explicit markup. While docutils provides a numbe
**Output**
**List Table**
List Table
==============
The "list-table" directive is used to create a table from data in a uniform two-level bullet list. "Uniform" means that each sublist (second-level list) must contain the same number of list items.
......@@ -185,7 +184,7 @@ The "list-table" directive is used to create a table from data in a uniform two-
- 1.99
- On a stick!
**CSV table**
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.
......@@ -210,7 +209,7 @@ The data may be internal (an integral part of the document) or external (a separ
crunchy, now would it?"
"Gannet Ripple", 1.99, "On a stick!"
**Roles**
Roles
=========
**Cross-referencing syntax**
......@@ -231,7 +230,7 @@ we know that, algebric formula
:math:`a^2 + b^2 + 2ab = (a+b)^2`
**Reference**
Reference
=============
`<https://www.sphinx-doc.org/en/master/usage/installation.html>`_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment