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/.
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
Built Distributions
File details
Details for the file mod2doctest-0.2.0.zip
.
File metadata
- Download URL: mod2doctest-0.2.0.zip
- Upload date:
- Size: 9.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 54de58d0509ab2f35aa2f571d9b1badd9a5e793bc3e56293d452a66b25ea3197 |
|
MD5 | 598b79966b9899f5fc6e4400ef270b33 |
|
BLAKE2b-256 | aba1b3d118ea123863d0ff63419afb80257a28291d0fdfcb5ebd853bd80ee8c6 |
File details
Details for the file mod2doctest-0.2.0.win32-py2.7.exe
.
File metadata
- Download URL: mod2doctest-0.2.0.win32-py2.7.exe
- Upload date:
- Size: 220.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3796606c98fde6eeacb7157240db9242a0a6de203d64ad190e85cf9d503b7e32 |
|
MD5 | 89a317b260a9a8cc86b4011b3024a088 |
|
BLAKE2b-256 | 99ac5091d8f02314d255b5b574e1d623428052426d5a96a7bbf25472aa513439 |
File details
Details for the file mod2doctest-0.2.0.win32-py2.6.exe
.
File metadata
- Download URL: mod2doctest-0.2.0.win32-py2.6.exe
- Upload date:
- Size: 220.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ac2790ade44516f88d6108eeec757ff339392e7b1ad4cbd9ba0f7e8e4868542 |
|
MD5 | 9a8b258d1939922d14d26f1a392fd056 |
|
BLAKE2b-256 | 03ae2c12e9e7bdd0c2895aec27215f8100d1f046e6b6e96f47de72a683f57f97 |
File details
Details for the file mod2doctest-0.2.0.win32-py2.5.exe
.
File metadata
- Download URL: mod2doctest-0.2.0.win32-py2.5.exe
- Upload date:
- Size: 85.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85a9c9adac6f89334e95ba0190dc80c6693bb0dc02cb25a76c93702322fe9eb4 |
|
MD5 | b978cc879cbeca977ca6167a3e5ec62e |
|
BLAKE2b-256 | 4cd883923f947881613a77b25f3a000a488dba99987afc6e3e67586062a9caa0 |
File details
Details for the file mod2doctest-0.2.0.win32-py2.4.exe
.
File metadata
- Download URL: mod2doctest-0.2.0.win32-py2.4.exe
- Upload date:
- Size: 85.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 34b14c10ed154324e0eecbaa7e9ebf2789e6168f5493df2e4ebed8c4aa0dadf8 |
|
MD5 | 476de27a9378e48026ca3376f946e895 |
|
BLAKE2b-256 | 61f9329393cdcd7a699dd21902d206e26098f9d15961a1fcded7538cb860eb42 |
File details
Details for the file mod2doctest-0.2.0-py2.7.egg
.
File metadata
- Download URL: mod2doctest-0.2.0-py2.7.egg
- Upload date:
- Size: 47.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 243f152337db1a7e01fc27da1a2950fc8d408d7e3f39d43360c9528b92db164e |
|
MD5 | f760f1ef68bd69b2a7a595d7d0210810 |
|
BLAKE2b-256 | 7eaaab52cdc78bfdd12cc8620084562991735818b0ca4fe4dc34c1ee98444a0c |
File details
Details for the file mod2doctest-0.2.0-py2.6.egg
.
File metadata
- Download URL: mod2doctest-0.2.0-py2.6.egg
- Upload date:
- Size: 47.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73c4d280d0277d4043546c5cb5ce0ed53c9f3f267700fdd1ddd5622d481ebaf3 |
|
MD5 | 2f21c4fbfcd89be7ffa02f3307e27a4a |
|
BLAKE2b-256 | 03370ca28331c4bdfeefb458733bc99919145e8a3c28d9faeaedefe0e7edda5c |
File details
Details for the file mod2doctest-0.2.0-py2.5.egg
.
File metadata
- Download URL: mod2doctest-0.2.0-py2.5.egg
- Upload date:
- Size: 47.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 518929c8e5a01fb9304d2a3056d651a950c7b5fef65a0846908f874c446d4a93 |
|
MD5 | a1103d057365badcdef9c1470a9bde6b |
|
BLAKE2b-256 | cc6c0000779e527a59625b7b08f265e5bbca9ed127efacc3c8fac436b66d0bc0 |
File details
Details for the file mod2doctest-0.2.0-py2.4.egg
.
File metadata
- Download URL: mod2doctest-0.2.0-py2.4.egg
- Upload date:
- Size: 47.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 784bdb3d6df6880e3bf5f29132e386cc13f3864c804cca631c37a4f978d0ce3f |
|
MD5 | 2a918d5fe2517d26690a0867bfb4bc98 |
|
BLAKE2b-256 | 0ff662904c7c7053a1c8466ba4227ef7daed2196d632f552bf5cf5d62118083a |