/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/doc/api/__init__.py

Merge with serialize-transform

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc/api/__init__.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""API Documentation for bzrlib.
 
18
 
 
19
This documentation is made up of doctest testable examples.
 
20
 
 
21
Look for bzrlib/doc/api/*.txt to read it.
 
22
 
 
23
This documentation documents the current best practice in using the library.
 
24
For details on specific apis, see pydoc on the api, or read the source.
 
25
"""
 
26
 
 
27
import doctest
 
28
import os
 
29
 
 
30
from bzrlib import tests
 
31
 
 
32
def load_tests(basic_tests, module, loader):
 
33
    """This module creates its own test suite with DocFileSuite."""
 
34
 
 
35
    dir_ = os.path.dirname(__file__)
 
36
    if os.path.isdir(dir_):
 
37
        candidates = os.listdir(dir_)
 
38
    else:
 
39
        candidates = []
 
40
    scripts = [candidate for candidate in candidates
 
41
               if candidate.endswith('.txt')]
 
42
    # since this module doesn't define tests, we ignore basic_tests
 
43
    suite = doctest.DocFileSuite(*scripts)
 
44
    # DocFileCase reduces the test id to the base name of the tested file, we
 
45
    # want the module to appears there.
 
46
    for t in tests.iter_suite_tests(suite):
 
47
        def make_new_test_id():
 
48
            new_id = '%s.DocFileTest(%s)' % ( __name__, t)
 
49
            return lambda: new_id
 
50
        t.id = make_new_test_id()
 
51
    return suite