Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Eclipse Projects
Oniro Core
docs
Commits
6effcd0e
Commit
6effcd0e
authored
4 years ago
by
Pooja Halappanavar
Browse files
Options
Downloads
Patches
Plain Diff
Update reStructuredText Basics.rst
parent
88414b83
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
documentation/source/readme/reStructuredText Basics.rst
+38
-12
38 additions, 12 deletions
documentation/source/readme/reStructuredText Basics.rst
with
38 additions
and
12 deletions
documentation/source/readme/reStructuredText Basics.rst
+
38
−
12
View file @
6effcd0e
...
...
@@ -17,9 +17,7 @@ Some writers also prefer reStructuredText because the markup standards are more
**Project setup**
=================
Use this link for complete installation and authoring process
`<https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html>`_
For complete setup of Sphinx and its installation process, refer `<https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html>`_.
**How to use reStructuredText**
...
...
@@ -60,8 +58,12 @@ For creating list just place an asterisk(*) or hyphen (-) at the start of a para
*example*
**Syntax**
.. figure:: Images/List.PNG
**Output**
* This is a bulleted list.
* It has two items too.
...
...
@@ -78,22 +80,27 @@ If you have a long bullet list of items, where each item is short, you can indic
*example*
**Syntax**
.. figure:: Images/multi-column_list.PNG
**Output**
this unordered list:
.. rst-class:: rst-columns
* A list of
* short items
* that should be
* displayed
* horizontally
* so it doesn't
* use up so much
* space on
* the page
* Displayed
* Horizontally
* Short items
* So it doesn't
* Space on
* That should be
* The page
* Use up so much
**Images**
==========
...
...
@@ -101,8 +108,11 @@ reSt supports an image directive, used like: .. figure:: Images/image name.PNG
*example*
**Syntax**
.. figure:: Images/multi_data.PNG
**Output**
**Directives**
==============
...
...
@@ -110,7 +120,14 @@ Directive is a generic block of explicit markup. While docutils provides a numbe
*example*
**Syntax**
.. figure:: Images/toctree.PNG
:width: 50px
:Height: 50px
**Output**
**List Table**
==============
...
...
@@ -119,9 +136,13 @@ The "list-table" directive is used to create a table from data in a uniform two-
*Example*
**Syntax**
.. figure:: Images/List-table.PNG
**Output**
.. list-table:: Frozen Delights!
:widths: 15 10 30
:header-rows: 1
...
...
@@ -150,8 +171,11 @@ The data may be internal (an integral part of the document) or external (a separ
*Example*
**Syntax**
.. figure:: Images/ csv_table.PNG
**Ouput**
.. csv-table:: Frozen Delights!
:header: "Treat", "Quantity", "Description"
...
...
@@ -171,8 +195,11 @@ Basically, you only need to write :role:`target` and a link will be created to t
**math**
**Syntax**
.. figure:: Images/math.PNG
**Output**
Since Pythagoras, we know that :math:`a^2 + b^2 = c^2`
...
...
@@ -189,4 +216,3 @@ we know that, algebric formula
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment