← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_rstx.py

  • Committer: Wouter van Heyst
  • Date: 2007-01-18 18:37:21 UTC
  • mto: (2234.3.3 0.14)
  • mto: This revision was merged to the branch mainline in revision 2243.
  • Revision ID: larstiq@larstiq.dyndns.org-20070118183721-78uzxifyyyoqxja9
(Alexander Belchenko) add windows installer check for python2.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_rstx.py
 
1
# Copyright 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
"""Generate ReStructuredText source for manual.
 
18
Based on manpage generator autodoc_man.py
 
19
 
 
20
Written by Alexander Belchenko
 
21
"""
 
22
 
 
23
import os
 
24
import sys
 
25
import textwrap
 
26
import time
 
27
 
 
28
import bzrlib
 
29
import bzrlib.help
 
30
import bzrlib.commands
 
31
 
 
32
 
 
33
def get_filename(options):
 
34
    """Provides name of manual"""
 
35
    return "%s_man.txt" % (options.bzr_name)
 
36
 
 
37
 
 
38
def infogen(options, outfile):
 
39
    """Create manual in RSTX format"""
 
40
    t = time.time()
 
41
    tt = time.gmtime(t)
 
42
    params = \
 
43
           { "bzrcmd": options.bzr_name,
 
44
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
45
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
46
             "version": bzrlib.__version__,
 
47
             }
 
48
    outfile.write(rstx_preamble % params)
 
49
    outfile.write(rstx_head % params)
 
50
    outfile.write(getcommand_list(params))
 
51
    outfile.write(getcommand_help(params))
 
52
    outfile.write(rstx_foot % params)
 
53
 
 
54
 
 
55
def command_name_list():
 
56
    """Builds a list of command names from bzrlib"""
 
57
    command_names = bzrlib.commands.builtin_command_names()
 
58
    command_names.sort()
 
59
    return command_names
 
60
 
 
61
 
 
62
def getcommand_list (params):
 
63
    """Builds summary help for command names in RSTX format"""
 
64
    bzrcmd = params["bzrcmd"]
 
65
    output = """
 
66
Command overview
 
67
================
 
68
"""
 
69
    for cmd_name in command_name_list():
 
70
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
71
        if cmd_object.hidden:
 
72
            continue
 
73
        cmd_help = cmd_object.help()
 
74
        if cmd_help:
 
75
            firstline = cmd_help.split('\n', 1)[0]
 
76
            usage = bzrlib.help.command_usage(cmd_object)
 
77
            tmp = '**%s**\n\t%s\n\n' % (usage, firstline)
 
78
            output = output + tmp
 
79
        else:
 
80
            raise RuntimeError, "Command '%s' has no help text" % (cmd_name)
 
81
    return output
 
82
 
 
83
 
 
84
def getcommand_help(params):
 
85
    """Shows individual options for a bzr command"""
 
86
    output="""
 
87
Command reference
 
88
=================
 
89
"""
 
90
    for cmd_name in command_name_list():
 
91
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
92
        if cmd_object.hidden:
 
93
            continue
 
94
        output = output + format_command(params, cmd_object, cmd_name)
 
95
    return output
 
96
 
 
97
 
 
98
def format_command (params, cmd, name):
 
99
    """Provides long help for each public command"""
 
100
    usage = bzrlib.help.command_usage(cmd)
 
101
    subsection_header = """
 
102
%s
 
103
%s
 
104
::
 
105
""" % (usage, '-'*len(usage))
 
106
 
 
107
    docsplit = cmd.help().split('\n')
 
108
    doc = '\n'.join([' '*4+line for line in docsplit])
 
109
        
 
110
    option_str = ""
 
111
    options = cmd.options()
 
112
    if options:
 
113
        option_str = "\n    Options:\n"
 
114
        for option_name, option in sorted(options.items()):
 
115
            l = '        --' + option_name
 
116
            if option.type is not None:
 
117
                l += ' ' + option.argname.upper()
 
118
            short_name = option.short_name()
 
119
            if short_name:
 
120
                assert len(short_name) == 1
 
121
                l += ', -' + short_name
 
122
            l += (30 - len(l)) * ' ' + option.help
 
123
            # TODO: Split help over multiple lines with
 
124
            # correct indenting and wrapping.
 
125
            wrapped = textwrap.fill(l, initial_indent='',
 
126
                                    subsequent_indent=30*' ')
 
127
            option_str = option_str + wrapped + '\n'
 
128
 
 
129
    aliases_str = ""
 
130
    if cmd.aliases:
 
131
        if len(cmd.aliases) > 1:
 
132
            aliases_str += '\n    Aliases: '
 
133
        else:
 
134
            aliases_str += '\n    Alias: '
 
135
        aliases_str += ', '.join(cmd.aliases)
 
136
        aliases_str += '\n'
 
137
 
 
138
    return subsection_header + option_str + aliases_str + "\n" + doc + "\n"
 
139
 
 
140
 
 
141
##
 
142
# TEMPLATES
 
143
 
 
144
rstx_preamble = """.. Large parts of this file are autogenerated from the output of
 
145
..     %(bzrcmd)s help commands
 
146
..     %(bzrcmd)s help <cmd>
 
147
..
 
148
.. Generation time: %(timestamp)s
 
149
 
 
150
=============================================
 
151
Man page for Bazaar (%(bzrcmd)s)
 
152
=============================================
 
153
 
 
154
:Date: %(datestamp)s
 
155
 
 
156
`Index <#id1>`_
 
157
 
 
158
-----
 
159
 
 
160
"""
 
161
 
 
162
 
 
163
rstx_head = """\
 
164
Name
 
165
====
 
166
Bazaar (%(bzrcmd)s) - next-generation distributed version control
 
167
 
 
168
Synopsis
 
169
========
 
170
**%(bzrcmd)s** *command* [ *command_options* ]
 
171
 
 
172
**%(bzrcmd)s help**
 
173
 
 
174
**%(bzrcmd)s help** *command*
 
175
 
 
176
 
 
177
Description
 
178
===========
 
179
Bazaar (or **%(bzrcmd)s**) is a project of Canonical to develop
 
180
an open source distributed version control system that is powerful,
 
181
friendly, and scalable. Version control means a system
 
182
that keeps track of previous revisions of software source code
 
183
or similar information and helps people work on it in teams.
 
184
"""
 
185
 
 
186
 
 
187
rstx_foot = """
 
188
Environment
 
189
===========
 
190
**BZRPATH**
 
191
                Path where **%(bzrcmd)s** is to look for external command.
 
192
 
 
193
**BZR_EMAIL**
 
194
                E-Mail address of the user. Overrides default user config.
 
195
 
 
196
**EMAIL**
 
197
                E-Mail address of the user. Overrides default user config.
 
198
 
 
199
**BZR_EDITOR**
 
200
                Editor for editing commit messages
 
201
 
 
202
**EDITOR**
 
203
                Editor for editing commit messages
 
204
 
 
205
**BZR_PLUGIN_PATH**
 
206
                Paths where bzr should look for plugins
 
207
 
 
208
**BZR_HOME**
 
209
                Home directory for bzr
 
210
 
 
211
 
 
212
Files
 
213
=====
 
214
 
 
215
**On Linux**:  ``~/.bazaar/bazaar.conf``
 
216
 
 
217
**On Windows**: ``C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf``
 
218
 
 
219
Contains the users default configuration. The section ``[DEFAULT]`` is
 
220
used to define general configuration that will be applied everywhere.
 
221
The section ``[ALIASES]`` can be used to create command aliases for
 
222
commonly used options.
 
223
 
 
224
A typical config file might look something like::
 
225
 
 
226
  [DEFAULT]
 
227
  email=John Doe <jdoe@isp.com>
 
228
 
 
229
  [ALIASES]
 
230
  commit = commit --strict
 
231
  log10 = log --short -r -10..-1
 
232
 
 
233
 
 
234
See also
 
235
========
 
236
http://www.bazaar-vcs.org/
 
237
 
 
238
--------------------
 
239
 
 
240
.. Contents::
 
241
    **Index**
 
242
"""