/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
5188.1.2 by Vincent Ladeuil
Add a skeleton texinfo builder for sphinx.
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
6379.6.7 by Jelmer Vernooij
Move importing from future until after doc string, otherwise the doc string will disappear.
17
"""A sphinx builder producing texinfo output."""
18
6379.6.3 by Jelmer Vernooij
Use absolute_import.
19
from __future__ import absolute_import
20
5188.1.2 by Vincent Ladeuil
Add a skeleton texinfo builder for sphinx.
21
from sphinx import builders
22
from sphinx.builders import text as _text_builder
23
5188.1.3 by Vincent Ladeuil
Rename sphinx related files into a better namespace.
24
from bzrlib.doc_generate.writers import texinfo as texinfo_writer
5188.1.2 by Vincent Ladeuil
Add a skeleton texinfo builder for sphinx.
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
5193.6.12 by Vincent Ladeuil
Implement a basic toctree generation.
35
    def get_target_uri(self, docname, typ=None):
5193.6.17 by Vincent Ladeuil
Some cosmetic tweaks and special char escaping.
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'
5193.6.12 by Vincent Ladeuil
Implement a basic toctree generation.
41
5188.1.2 by Vincent Ladeuil
Add a skeleton texinfo builder for sphinx.
42
43
def setup(app):
44
    app.add_builder(TexinfoBuilder)