A way to convert any Python module to a doctest ready doc string.
Project description
mod2doctest is a module that converts a python module to a doctest compatible docstring.
It’s kind of like taking a python script, pasting it into an interactive interpreter and then copying the output back into a docstring.
However, mod2doctest has many convenience to make this process easier like:
Providing #> and #| comments: #> prints to both your docstring and stdout and #| print just to your docstring (which will show up as text in a sphinx generated webpage)
adding ellipse markers for memory id / trace back
Cleaning up / formatting your docstring for sphinx inclusion
and a couple of other things, too.
For full documentation and several examples please visit http://packages.python.org/mod2doctest/.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for mod2doctest-0.2.0.win32-py2.7.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3796606c98fde6eeacb7157240db9242a0a6de203d64ad190e85cf9d503b7e32 |
|
| MD5 | 89a317b260a9a8cc86b4011b3024a088 |
|
| BLAKE2b-256 | 99ac5091d8f02314d255b5b574e1d623428052426d5a96a7bbf25472aa513439 |
Hashes for mod2doctest-0.2.0.win32-py2.6.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4ac2790ade44516f88d6108eeec757ff339392e7b1ad4cbd9ba0f7e8e4868542 |
|
| MD5 | 9a8b258d1939922d14d26f1a392fd056 |
|
| BLAKE2b-256 | 03ae2c12e9e7bdd0c2895aec27215f8100d1f046e6b6e96f47de72a683f57f97 |
Hashes for mod2doctest-0.2.0.win32-py2.5.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 85a9c9adac6f89334e95ba0190dc80c6693bb0dc02cb25a76c93702322fe9eb4 |
|
| MD5 | b978cc879cbeca977ca6167a3e5ec62e |
|
| BLAKE2b-256 | 4cd883923f947881613a77b25f3a000a488dba99987afc6e3e67586062a9caa0 |
Hashes for mod2doctest-0.2.0.win32-py2.4.exe
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 34b14c10ed154324e0eecbaa7e9ebf2789e6168f5493df2e4ebed8c4aa0dadf8 |
|
| MD5 | 476de27a9378e48026ca3376f946e895 |
|
| BLAKE2b-256 | 61f9329393cdcd7a699dd21902d206e26098f9d15961a1fcded7538cb860eb42 |
