Basic Markup

GitHub README.MD markup

A First Level Header
====================

A Second Level Header
---------------------

### Header 3

*** (Triple stars or hyphens for a line to divide sections)

> This is a blockquote.
> 
> This is the second paragraph in the blockquote.

Some of these words *are emphasized*.
Use two asterisks for **strong emphasis**.

Code written inline needs `back quotes`.

List items with single *, + or - signs.

Sphinx code markup

A First Level Header
====================

A Second Level Header
---------------------

.. note:: Note in a box
.. warning:: Warning in a box

A paragraph can have **bold** and *italic* inline emphasis.
The next line is concatenated to previous.

Skip a line for new paragraph. Use triple hyphen for longer sep-a---ra-tions.

:type par1: description of param type
:param par1: 'type' and 'param' can be placed anywhere
:parameter par2: Sphinx will congregate all args into a list
:type arg1: list
:arg arg1: This is another way
:argument arg2: And here it is again
    Can start or continue on the next indented line.
:rtype: Return type to be sent
:return: Describe the returned object in more detail
    
Optional intro to code snippet here::

    Skip a line before starting code.
 At least one space indent for all code.
 
Skip a line and return to normal indent level to end code.
        
Use triple less-than signs for colored Python code. 

>>> for i in range(10):
    print "this will have color formatting"

Short method doc with DIY formatting:

    """ summary

    description

    - **param** --- desc
    - *return* --- desc
    """

Or a longer template with Sphinx keywords:

    """ summary

    description

    :type name: type optional
    :arg name: desc
    :returns: desc

    (optional intro to block)::

        Skip line and indent monospace block

    >>> python colored code example
    ... more code
    """

Leave a comment