:mod:`doctest`
==============

.. automodule:: doctest

   
   
   Functions
   ---------
   .. autosummary::
      :toctree:generated/
      :template:function_custom.rst

   
      DocFileSuite
      DocFileTest
      DocTestSuite
      debug
      debug_script
      debug_src
      namedtuple
      register_optionflag
      run_docstring_examples
      script_from_examples
      set_unittest_reportflags
      testfile
      testmod
      testsource

   .. toctree::
       :maxdepth: 1
       :hidden:

   
       generated/doctest.DocFileSuite
       generated/doctest.DocFileTest
       generated/doctest.DocTestSuite
       generated/doctest.debug
       generated/doctest.debug_script
       generated/doctest.debug_src
       generated/doctest.namedtuple
       generated/doctest.register_optionflag
       generated/doctest.run_docstring_examples
       generated/doctest.script_from_examples
       generated/doctest.set_unittest_reportflags
       generated/doctest.testfile
       generated/doctest.testmod
       generated/doctest.testsource
      
   
   

   
   
   Classes
   -------
   .. autosummary::
      :toctree:generated/
      :template:class_all_methods.rst

   
      DebugRunner
      DocFileCase
      DocTest
      DocTestCase
      DocTestFinder
      DocTestParser
      DocTestRunner
      Example
      OutputChecker
      SkipDocTestCase
      StringIO
      TestResults
      Tester

   .. toctree::
       :maxdepth: 1
       :hidden:

   
       generated/doctest.DebugRunner
       generated/doctest.DocFileCase
       generated/doctest.DocTest
       generated/doctest.DocTestCase
       generated/doctest.DocTestFinder
       generated/doctest.DocTestParser
       generated/doctest.DocTestRunner
       generated/doctest.Example
       generated/doctest.OutputChecker
       generated/doctest.SkipDocTestCase
       generated/doctest.StringIO
       generated/doctest.TestResults
       generated/doctest.Tester

   
   

   
   
   Exceptions
   ----------
   .. autosummary::
      :toctree:

   
      DocTestFailure
      UnexpectedException