← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc_generate/builders/texinfo.py

Add bzrlib.pyutils, which has get_named_object, a wrapper around __import__.

This is used to replace various ad hoc implementations of the same logic,
notably the version used in registry's _LazyObjectGetter which had a bug when
getting a module without also getting a member.  And of course, this new
function has unit tests, unlike the replaced code.

This also adds a KnownHooksRegistry subclass to provide a more natural home for
some other logic.

I'm not thrilled about the name of the new module or the new functions, but it's
hard to think of good names for such generic functionality.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc_generate/builders/texinfo.py
 
1
# Copyright (C) 2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""A sphinx builder producing texinfo output."""
 
18
 
 
19
from sphinx import builders
 
20
from sphinx.builders import text as _text_builder
 
21
 
 
22
from bzrlib.doc_generate.writers import texinfo as texinfo_writer
 
23
 
 
24
class TexinfoBuilder(_text_builder.TextBuilder):
 
25
 
 
26
    name = 'texinfo'
 
27
    format = 'texinfo'
 
28
    out_suffix = '.texi'
 
29
 
 
30
    def prepare_writing(self, docnames):
 
31
        self.writer = texinfo_writer.TexinfoWriter(self)
 
32
 
 
33
    def get_target_uri(self, docname, typ=None):
 
34
        # FIXME: Revisit when info file generation is defined (the suffix is
 
35
        # left here for clarity but the final version may just get rid of
 
36
        # it). And we probalby will join several files into bigger info files
 
37
        # anyway. -- vila 20100506
 
38
        return docname + '.info'
 
39
 
 
40
 
 
41
def setup(app):
 
42
    app.add_builder(TexinfoBuilder)