← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to generate_docs.py

Refactored the export code to make it easier to add new export formats.

Show diffs side-by-side

added added

removed removed

Lines of Context:
generate_docs.py
1
 
#!/usr/bin/python
2
 
 
3
 
# Copyright 2005 Canonical Ltd.
4
 
#
5
 
# This program is free software; you can redistribute it and/or modify
6
 
# it under the terms of the GNU General Public License as published by
7
 
# the Free Software Foundation; either version 2 of the License, or
8
 
# (at your option) any later version.
9
 
#
10
 
# This program is distributed in the hope that it will be useful,
11
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
# GNU General Public License for more details.
14
 
#
15
 
# You should have received a copy of the GNU General Public License
16
 
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
 
 
19
 
"""%(prog)s - generate information from built-in bzr help
20
 
 
21
 
%(prog)s creates a file with information on bzr in one of
22
 
several different output formats:
23
 
 
24
 
    man              man page
25
 
    bash_completion  bash completion script
26
 
    ...
27
 
 
28
 
Examples: 
29
 
 
30
 
    python2.4 generated-docs.py man
31
 
    python2.4 generated-docs.py bash_completion
32
 
 
33
 
Run "%(prog)s --help" for the option reference.
34
 
"""
35
 
 
36
 
import bzrlib.commands
37
 
import sys
38
 
from optparse import OptionParser
39
 
 
40
 
import tools.doc_generate
41
 
 
42
 
def main(argv):
43
 
    parser = OptionParser(usage="""%prog [options] OUTPUT_FORMAT
44
 
 
45
 
Available OUTPUT_FORMAT:
46
 
 
47
 
    man              man page
48
 
    rstx             man page in ReStructuredText format
49
 
    bash_completion  bash completion script""")
50
 
 
51
 
    parser.add_option("-s", "--show-filename",
52
 
                      action="store_true", dest="show_filename", default=False,
53
 
                      help="print default filename on stdout")
54
 
 
55
 
    parser.add_option("-o", "--output", dest="filename", metavar="FILE",
56
 
                      help="write output to FILE")
57
 
 
58
 
    parser.add_option("-b", "--bzr-name",
59
 
                      dest="bzr_name", default="bzr", metavar="EXEC_NAME",
60
 
                      help="name of bzr executable")
61
 
 
62
 
    parser.add_option("-e", "--examples",
63
 
                      action="callback", callback=print_extended_help,
64
 
                      help="Examples of ways to call generate_doc")
65
 
 
66
 
 
67
 
    (options, args) = parser.parse_args(argv)
68
 
 
69
 
    if len(args) != 2:
70
 
        parser.print_help()
71
 
        sys.exit(1)
72
 
    
73
 
    bzrlib.commands.install_bzr_command_hooks()
74
 
 
75
 
    infogen_type = args[1]
76
 
    infogen_mod = tools.doc_generate.get_module(infogen_type)
77
 
 
78
 
    if options.filename:
79
 
        outfilename = options.filename
80
 
    else:
81
 
        outfilename = infogen_mod.get_filename(options)
82
 
 
83
 
    if outfilename == "-":
84
 
        outfile = sys.stdout
85
 
    else:
86
 
        outfile = open(outfilename,"w")
87
 
 
88
 
    if options.show_filename and (outfilename != "-"):
89
 
        sys.stdout.write(outfilename)
90
 
        sys.stdout.write('\n')
91
 
    
92
 
    infogen_mod.infogen(options, outfile)
93
 
 
94
 
def print_extended_help(option, opt, value, parser):
95
 
    """ Program help examples
96
 
 
97
 
    Prints out the examples stored in the docstring. 
98
 
 
99
 
    """
100
 
    sys.stdout.write(__doc__ % {"prog":sys.argv[0]})
101
 
    sys.stdout.write('\n')
102
 
    sys.exit(0)
103
 
 
104
 
if __name__ == '__main__':
105
 
    main(sys.argv)