Skip to main content

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.

Files for mod2doctest, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size mod2doctest-0.2.0.zip (9.6 kB) File type Source Python version None Upload date Hashes View
Filename, size mod2doctest-0.2.0.win32-py2.7.exe (220.0 kB) File type Windows Installer Python version 2.7 Upload date Hashes View
Filename, size mod2doctest-0.2.0.win32-py2.6.exe (220.0 kB) File type Windows Installer Python version 2.6 Upload date Hashes View
Filename, size mod2doctest-0.2.0.win32-py2.5.exe (85.3 kB) File type Windows Installer Python version 2.5 Upload date Hashes View
Filename, size mod2doctest-0.2.0.win32-py2.4.exe (85.3 kB) File type Windows Installer Python version 2.4 Upload date Hashes View
Filename, size mod2doctest-0.2.0-py2.7.egg (47.6 kB) File type Egg Python version 2.7 Upload date Hashes View
Filename, size mod2doctest-0.2.0-py2.6.egg (47.7 kB) File type Egg Python version 2.6 Upload date Hashes View
Filename, size mod2doctest-0.2.0-py2.5.egg (47.7 kB) File type Egg Python version 2.5 Upload date Hashes View
Filename, size mod2doctest-0.2.0-py2.4.egg (47.9 kB) File type Egg Python version 2.4 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page