← 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

(abentley) Use colocated branch names as nicknames. (Aaron Bentley)

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 __future__ import absolute_import
 
20
 
 
21
from sphinx import builders
 
22
from sphinx.builders import text as _text_builder
 
23
 
 
24
from bzrlib.doc_generate.writers import texinfo as texinfo_writer
 
25
 
 
26
class TexinfoBuilder(_text_builder.TextBuilder):
 
27
 
 
28
    name = 'texinfo'
 
29
    format = 'texinfo'
 
30
    out_suffix = '.texi'
 
31
 
 
32
    def prepare_writing(self, docnames):
 
33
        self.writer = texinfo_writer.TexinfoWriter(self)
 
34
 
 
35
    def get_target_uri(self, docname, typ=None):
 
36
        # FIXME: Revisit when info file generation is defined (the suffix is
 
37
        # left here for clarity but the final version may just get rid of
 
38
        # it). And we probalby will join several files into bigger info files
 
39
        # anyway. -- vila 20100506
 
40
        return docname + '.info'
 
41
 
 
42
 
 
43
def setup(app):
 
44
    app.add_builder(TexinfoBuilder)