Skip to main content

A reference for how reStructuredText blocks are rendered by Github and PyPI.

Project description

Paragraph 1, no literal syntax

>>> indented_doctest_block()
None

Paragraph 2, no literal syntax

>>> unindented_doctest_block()
None

Paragraph 3, no literal syntax

def foo():
return None

Paragraph 4, expanded literal syntax

::

def foo():
return None

Paragraph 5, partially minimized literal syntax ::

def foo():
return None

Paragraph 6, fully minimized literal syntax::

def foo():
return None

Paragraph 7, code block, no language

.. code::

def foo():
return None

Paragraph 8, code block, language=python

.. code:: python

def foo():
return None

Paragraph 9, Sphinx doctest block

.. doctest::

def foo():
return None

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypi-rst-ref-0.0.4.tar.gz (1.3 kB view details)

Uploaded Source

File details

Details for the file pypi-rst-ref-0.0.4.tar.gz.

File metadata

File hashes

Hashes for pypi-rst-ref-0.0.4.tar.gz
Algorithm Hash digest
SHA256 129d99c7dae2a5b04f74cc3a133e5f3ddce18c349bdc45ca66776b82f16bc326
MD5 8b999c2cedfe4343a1010db94643520f
BLAKE2b-256 36857ff6b10f057ad2b3d1d6ea3a2a48a0aedc5a2cd9c9fbd81d61f0b52e34fb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page