Code Paragraph Markup in Sphinx Documentation

Posted on Updated on

Note

Code :

.. note::
        Note Paragraph

Tampilan :

note paragraph

Warning

Code :

.. warning::
        An important bit of information about an API that a user should be very aware of
        when using whatever bit of API the warning pertains to. The content of the directive
        should be written in complete sentences and include all appropriate punctuation.
        This differs from note in that it is recommended over note for information regarding security.

Tampilan :

warning

Version

Code :

.. versionadded:: 90.23.21

.. versionchanged:: 123.3

.. deprecated:: 123.4

Tampilan :

New in version 90.23.21.

Changed in version 123.3.

Deprecated since version 123.4.

See Also

Code :

.. seealso::
        The seealso directive is typically placed in a section just before any sub-sections.
        For the HTML output, it is shown boxed off from the main flow of the text.

Tampilan :

see also

Paragraph Heading

Code :

.. rubric:: Title of Paragraph

Tampilan :Title of Paragraph

Centered

Code :

.. centered::
        This directive creates a centered boldfaced line of text. Use it as follows:

Tampilan :

This directive creates a centered boldfaced line of text. Use it as follows:

hlist (Horizontally List)

Code :

.. hlist::
   :columns: 3

   * A list of
   * short items
   * that should be
   * displayed
   * horizontally

Tampilan :

  • A list of
  • short items
  • that should be
  • displayed
  • horizontally

Glossary

Code :

.. glossary::

        term 1
        term 2
                Definition of both terms.

        term 3
                Definition terms 3

        term 3
                Definition terms 3

Tampilan :

term 1
term 2
Definition of both terms.
term 3
Definition terms 3
term 4
Definition terms 4

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s