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


Changelog
=========

0.0.3
-----

- Whitespace

0.0.2
-----

- Added a doctest block

0.0.1
-----

- Initial release

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.3.tar.gz (1.4 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for pypi-rst-ref-0.0.3.tar.gz
Algorithm Hash digest
SHA256 e1f7c552c4cf93a34dc654788a15fa067042513aa367d357761ccd8929beda1b
MD5 31006284d421ee81a426b9d34752e10e
BLAKE2b-256 65b53276b4a3d8038b7bd54e70b491fefaa614d75d17e9e9422f439c5df7950d

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