Playing with reStructuredText

Updated: May 07, 2024

This is a paragraph. This is an example to italics, this is an example to bold, this is an example to passthrough, this is an example to literal text, this is an example to single word hyper link google [3], this is an example to same google but with space between [4], this is also an example example to google link [3], this is also an example to google link with space between [4]

this is an example to footnote [CIT01] reference, footnote reference can be [1] auto [2] numbered, this is an example to https://reddit.com url. Something need to be changed.

Example bullet list,

  • one

  • two

    • one one

    • one two

  1. one

  2. two

    1. one one

    2. one two

This is also numbered list,

  1. one

  2. two

    1. one one

    2. one two

Term 1

Definition 1

Term 2

Definition 2

This is a normal paragraph without broken lines

this paragraph
contains broken lines

this is normal paragraph introducing field definition

variable0:

variable0 definition

variable1:

variable1 definition

this is normal paragraph introducing option definition

-a

short option

--analog

long option

this is literal block
anything written here will show
differently

this is normal paragraph to show shortand liternal block beginning

this is liternal block
with broken lines

this is example for quoted block

> this line is not intended
> and also lines can be broken
> this block begins with ">" character

this is example to line blocks

| this line is
| a line block

this is example to block quote

“this is a quote”

—Mohan R

this is normal paragraph introducing c code highlighting through highlight:: directive

#include <stdio.h>
int main(int argc, char* argv[]) {
     printf("hello world\n");
     return 0;
}

this is normal paragraph introducing bash code highlighting through highlight:: directive

$ echo "this is import bash" or is this python?

this is normal paragraph introducing python highlighting through highlight:: directive

import os
import sys
def hello():
     print("hello world")

this is a normal paragraph introducing c highlighting through code-block:: directive

1#include <stdio.h>
2int main(int argc, char* argv[]) {
3     printf("hello world\n");
4     return 0;
5}

this is a normal paragraph introducing console highlighting through code-block:: directive

$ echo "is this import bash" or is this python?

this is a normal paragraph introducing python highlighting through code-block:: directive

1import os
2import sys
3def hello():
4     print("hello world")

this is a normal paragraph introducing literalinclude:: directive

 1#include <stdio.h>
 2
 3static void helloworld(void) {
 4	printf("helloworld\n");
 5}
 6
 7int main(int argc, char *argv[]) {
 8	helloworld();
 9	return 0;
10}

this is a normal paragraph introducing same literalinclude:: directive with specific lines set as :lines: 3-5, :lines:8 and lines:1-

static void helloworld(void) {
	printf("helloworld\n");
}
	helloworld();
#include <stdio.h>

static void helloworld(void) {
	printf("helloworld\n");
}

int main(int argc, char *argv[]) {
	helloworld();
	return 0;
}

this is normal paragraph introducing doctest

>>> 1 + 1
2

this is a normal paragraph introducing table

head1

head2

col1

col2

this is a paragraph introducing inline link to python.

this is one internal section

this paragraph contains this is one internal section link to the section it contains.

this is a paragraph this contains inline roles like italic, bold text, literal text, subscript text, superscript text

Attention

this is an attention text

Caution

this is caution text

Danger

this is danger text

Error

this is error text

Hint

this is hint text

Important

this is important text

Note

this is note text

Tip

this is tip text

Warning

this is warning text

Generic Admonition

this is admonition text

This is a centered text

  • one

  • two

  • three

  • four

this is a normal paragraph introducing image

../../_images/test.jpg

some stupid shit called ephigraph

—Mohan R

Table with Title

head1

head2

col1

col2

CSV Table

head1

head2

col1

col2

List Table

head1

head2

col1

col2


[CIT01]

example reference