Basics usage

Writing Content

Under /docs/ directory, open a .rst file that you want to edit with Github or your favourite text editor.

Enter something to the file then save and commit to the branch.

Viewing the Content

The most important thing about developing is viewing your change.

After adding content to your file. Make a commit in your Git branch and go to Document Builds Check for build status, if build successful, you can click the completed build then click the buttons view docs on the right to view your change.

How to Write Headers

Section hearders: .. code-block:

This is a Section Header
========================

Parts headers: .. code-block:

######################
This is a parts header
######################

And all the other header types:

# for parts header, with overline,
* for chapters header, with overline,
= for sections header
- for subsections header
^ for subsubsections header
” for paragraphs header

How to Write Lists

This is a list.

point list item 1
point list item 2
- nested list item

number list item 1
number list item 2
and another number list, item 1
another number list, item 2

How to add Notes

Note

This is a Note, and here’s how you can use it.

.. note::

followed by the notes that you want to write.

How to add Tips

Tip

You can use tips like this:: .. tip::

followed by the tips that you want to write.

How to add Images

You can add beutiful images too with this code:

.. image:: ../Media/Images/beautiful-image.jpg
    :width: 80%
    :align: center
    :alt: this is a beautiful image

Styling your Documentations

Bold

Text wrapped like **this** is Bolded.

Italic

Text wrapped like *this* is Italic.

code sample

Text wrapped like ``this`` is for code sample.

Literal blocks

this is how you write a block of text:

.. code-block::
This is a block of text

Labels

This is a Label and it can be used as this .. code-block:

This is a :guilabel:`Label`

HyperLinks

This is a link to Document Home

This is a link to `Document Home <https://mza79-rtd-tutorial.readthedocs.io/en/stable/index.html>`_

Technical Terms

Technical terms are defined in a glossary file which has this declaration at the top: .. glossary::

This is a technical term, and it can be used with:

:term:`technical term`