This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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/.

Release History

Release History

This version
History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

History Node

0.0.6

History Node

0.0.5

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
mod2doctest-0.2.0-py2.4.egg (47.9 kB) Copy SHA256 Checksum SHA256 2.4 Egg Sep 26, 2010
mod2doctest-0.2.0-py2.5.egg (47.7 kB) Copy SHA256 Checksum SHA256 2.5 Egg Sep 26, 2010
mod2doctest-0.2.0-py2.6.egg (47.7 kB) Copy SHA256 Checksum SHA256 2.6 Egg Sep 26, 2010
mod2doctest-0.2.0-py2.7.egg (47.6 kB) Copy SHA256 Checksum SHA256 2.7 Egg Sep 26, 2010
mod2doctest-0.2.0.win32-py2.4.exe (85.3 kB) Copy SHA256 Checksum SHA256 2.4 Windows Installer Sep 26, 2010
mod2doctest-0.2.0.win32-py2.5.exe (85.3 kB) Copy SHA256 Checksum SHA256 2.5 Windows Installer Sep 26, 2010
mod2doctest-0.2.0.win32-py2.6.exe (220.0 kB) Copy SHA256 Checksum SHA256 2.6 Windows Installer Sep 26, 2010
mod2doctest-0.2.0.win32-py2.7.exe (220.0 kB) Copy SHA256 Checksum SHA256 2.7 Windows Installer Sep 26, 2010
mod2doctest-0.2.0.zip (9.6 kB) Copy SHA256 Checksum SHA256 Source Sep 26, 2010

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting