Welcome to Learning Read the Docs’s documentation!

This tutorial is for learning basic sytanx Commands for read the docs.

Italic content with Single astric.

Bold content with double astric.

decorated box with double back ticks.

List items should be with astric.

• Item1
• Item2
• Item3

Numbered List with hash followed by dot

1. Item1
2. Item2
3. Item3

Adding Image example:

Code that we wanted to add:

private static string GetMessageFromException(Exception ex)
{
    if (ex ==null) return "";
    if (ex.InnerException != null)
    {
        return GetMessageFromException(ex.InnerException);
    }
        return ex.message;
}

If code is single language for the documentation we can add it on conf.py file under pygments section add below line.

highlight_language = csharp

Testing Continuous Integration

Testing using Shiny branch

Table Syntax

• Method 1:

============== ================ ======== ============
Platform        Self Contained?  Cost     Flexibility
============== ================ ======== ============
Rasberry pi       No              $40      Limitless
Lego Mindstro   Yes             $350     Medium
============== ================ ======== ============

Result:

Platform	Self Contained?	Cost	Flexibility
Rasberry pi	No	$40	Limitless
Lego Mindstro	Yes	$350	Medium

• Method 2:

+--------------+----------------+--------+------------+
| Platform     | Self Contained?|  Cost  | Flexibility|
|              |                |        |            |
+==============+================+========+============+
| Rasberry pi  |     No         |   $40  | Limitless  |
+--------------+----------------+--------+------------+
| Lego Mindstro|   Yes          |   $350 |    Medium  |
+--------------+----------------+--------+------------+

Result:

Platform	Self Contained?	Cost	Flexibility
Rasberry pi	No	$40	Limitless
Lego Mindstro	Yes	$350	Medium

• Method 3:

.. list-table:: Comparison
   :widths : 20 10 10 15
   :header-rows: 1

* - Platform
    - Self-contained?
    - Cost
    - Flexibility
* - Raspberry Pi
    - No
    - $30
    - Limitless
* - Lego Mindstorms
    - Yes
    - $350
    - Medium

Result:

Comparison :widths : 20 10 10 15

Platform	Self-contained?	Cost	Flexibility
Raspberry Pi	No	$30	Limitless
Lego Mindstorms	Yes	$350	Medium

• Method 4:

.. csv-table:: Comparison
   :header: Platform, If-contained? , Cost, Flexibility
   :widths: 15 10 30 30

   Raspberry pi,No,$30,Limitless
   Lego Mindstorms, Yes, $350,Medium

Result:

Comparison

Platform	If-contained?	Cost	Flexibility
Raspberry pi	No	$30	Limitless
Lego Mindstorms	Yes	$350	Medium

Admonition Syntax

• Caution

Syntax:

.. caution::
   This is the example for **Caution** admonition.

Result:

Caution

This is the example for Caution admonition.

• Danger

Syntax:

.. danger::
   This is the example for **danger** admonition.

Result:

Danger

This is the example for danger admonition.

• Tip

Syntax:

.. tip::
   This is the example for **tip** admonition.

Result:

Tip

This is the example for tip admonition.

• Note

Syntax:

.. note::
   This is the example for **Caution** admonition.

Result:

Note

This is the example for note admonition.