]> granicus.if.org Git - python/commitdiff
Activate the Sphinx doctest extension and convert howto/functional to use it.
authorGeorg Brandl <georg@python.org>
Sat, 22 Mar 2008 10:56:23 +0000 (10:56 +0000)
committerGeorg Brandl <georg@python.org>
Sat, 22 Mar 2008 10:56:23 +0000 (10:56 +0000)
Doc/Makefile
Doc/conf.py
Doc/library/decimal.rst

index e94be8160d6972bb3ae4cd8783a776969fd8acbd..64a1b2fe048d5f114e053cc9e48bd229eea031f2 100644 (file)
@@ -82,6 +82,11 @@ coverage: BUILDER = coverage
 coverage: build
        @echo "Coverage finished; see c.txt and python.txt in build/coverage"
 
+doctest: BUILDER = doctest
+doctest: build
+       @echo "Testing of doctests in the sources finished, look at the " \
+             "results in build/doctest/output.txt"
+
 clean:
        -rm -rf build/*
        -rm -rf tools/sphinx
index 82d16b86f5734b2a890a324227b2a08c02adb192..f6c08c517862968fe94013e2db56d3a9c45d8b5d 100644 (file)
@@ -13,7 +13,8 @@ sys.path.append('tools/sphinxext')
 # General configuration
 # ---------------------
 
-extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.refcounting', 'sphinx.ext.coverage',
+              'sphinx.ext.doctest']
 templates_path = ['tools/sphinxext']
 
 # General substitutions.
index 2d2ae938bd1ed3e26edb106a130f9e18929ecb72..cbd3950cf677cc8ed378e479434fd6f0c9380a1d 100644 (file)
 
 .. sectionauthor:: Raymond D. Hettinger <python at rcn.com>
 
-
 .. versionadded:: 2.4
 
+.. testsetup:: *
+
+   from decimal import *
+
 The :mod:`decimal` module provides support for decimal floating point
 arithmetic.  It offers several advantages over the :class:`float` datatype:
 
@@ -47,7 +50,7 @@ arithmetic.  It offers several advantages over the :class:`float` datatype:
 
 * Unlike hardware based binary floating point, the decimal module has a user
   alterable precision (defaulting to 28 places) which can be as large as needed for
-  a given problem::
+  a given problem:
 
      >>> getcontext().prec = 6
      >>> Decimal(1) / Decimal(7)
@@ -115,7 +118,9 @@ Quick-start Tutorial
 
 The usual start to using decimals is importing the module, viewing the current
 context with :func:`getcontext` and, if necessary, setting new values for
-precision, rounding, or enabled traps::
+precision, rounding, or enabled traps:
+
+.. doctest:: newcontext
 
    >>> from decimal import *
    >>> getcontext()
@@ -130,7 +135,7 @@ create a Decimal from a :class:`float`, first convert it to a string.  This
 serves as an explicit reminder of the details of the conversion (including
 representation error).  Decimal numbers include special values such as
 :const:`NaN` which stands for "Not a number", positive and negative
-:const:`Infinity`, and :const:`-0`.         ::
+:const:`Infinity`, and :const:`-0`.
 
    >>> Decimal(10)
    Decimal('10')
@@ -149,7 +154,9 @@ representation error).  Decimal numbers include special values such as
 
 The significance of a new Decimal is determined solely by the number of digits
 input.  Context precision and rounding only come into play during arithmetic
-operations. ::
+operations.
+
+.. doctest:: newcontext
 
    >>> getcontext().prec = 6
    >>> Decimal('3.0')