Parse, test, and assert RST code-blocks
Project description
Parse, test, and assert RST code-blocks
Installation
$ pip install readmetester
Usage
readmetester [-h] [--version] [README.rst]
If a README.rst file is present in the current working directory it will be used if no arguments are provided
$ readmetester README.rst
Documenting
Python code begins with ">>> "
Continuation lines begin with "... "
Expected output can be quoted or unquoted
.. code-block:: python
>>> n = [
... "zero",
... "one",
... "two",
... ]
>>> for c, i in enumerate(n):
... print(c, i)
0 zero
1 one
2 two
Styles can be configured in a pyproject.toml file
[tool.readmetester]
style = "monokai"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
readmetester-2.4.1.tar.gz
(11.3 kB
view hashes)
Built Distribution
Close
Hashes for readmetester-2.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f471b3180056171dd496e70ef64a63194b341c5eb33ee85c2d9121b885b80ea1 |
|
MD5 | bea7e1e2352f7de26a54b7b73abca884 |
|
BLAKE2b-256 | 9e15720ead3c3ddff62eb79b466adeaf7014ccee5bf4c0001f2dac2ff33f2021 |