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
0.0.2
-----
- Added a doctest block
0.0.1
-----
- Initial release
>>> 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
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.2.tar.gz
(1.4 kB
view details)
File details
Details for the file pypi-rst-ref-0.0.2.tar.gz
.
File metadata
- Download URL: pypi-rst-ref-0.0.2.tar.gz
- Upload date:
- Size: 1.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a061d70010f60eae6f7e9505cd1524d5989ec15e97f14dc6e14d4253927fcfe9 |
|
MD5 | 248bbee41127e240e3820efee44ac44a |
|
BLAKE2b-256 | 08e72a7ba42d5d50a3664ee5c43f024cb0871b30562ac42db599665507e50de6 |