~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_rstx.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-19 02:24:15 UTC
  • mto: This revision was merged to the branch mainline in revision 3944.
  • Revision ID: ian.clatworthy@canonical.com-20090119022415-mo0mcfeiexfktgwt
apply jam's log --short fix (Ian Clatworthy)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright 2006 Canonical Ltd.
 
1
# Copyright 2006-2007 Canonical Ltd.
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
"""Generate ReStructuredText source for manual.
18
 
Based on manpage generator autodoc_man.py
 
17
"""Generate ReStructuredText source for the User Reference Manual.
 
18
Loosely based on the manpage generator autodoc_man.py.
19
19
 
20
 
Written by Alexander Belchenko
 
20
Written by the Bazaar community.
21
21
"""
22
22
 
23
23
import os
27
27
 
28
28
import bzrlib
29
29
import bzrlib.help
 
30
import bzrlib.help_topics
30
31
import bzrlib.commands
 
32
import bzrlib.osutils
31
33
 
32
34
 
33
35
def get_filename(options):
45
47
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
46
48
             "version": bzrlib.__version__,
47
49
             }
 
50
    nominated_filename = getattr(options, 'filename', None)
 
51
    if nominated_filename is None:
 
52
        topic_dir = None
 
53
    else:
 
54
        topic_dir = bzrlib.osutils.dirname(nominated_filename)
48
55
    outfile.write(rstx_preamble % params)
49
56
    outfile.write(rstx_head % params)
50
 
    outfile.write(getcommand_list(params))
51
 
    outfile.write(getcommand_help(params))
 
57
    outfile.write(_get_body(params, topic_dir))
52
58
    outfile.write(rstx_foot % params)
53
59
 
54
60
 
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.__doc__.split('\n')
108
 
    doc = '\n'.join([' '*4 + docsplit[0]] + docsplit[1:])
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
 
    return subsection_header + option_str + "\n" + doc + "\n"
 
61
def _get_body(params, topic_dir):
 
62
    """Build the manual content."""
 
63
    from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
 
64
    registry = bzrlib.help_topics.topic_registry
 
65
    result = []
 
66
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
 
67
        output_dir=topic_dir))
 
68
    result.append(_get_section(registry, SECT_LIST, "Lists",
 
69
        output_dir=topic_dir))
 
70
    result.append(_get_commands_section(registry))
 
71
    #result.append(_get_section(registry, SECT_PLUGIN, "Standard Plug-ins"))
 
72
    return "\n".join(result)
 
73
 
 
74
 
 
75
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
 
76
        output_dir=None):
 
77
    """Build the manual part from topics matching that section.
 
78
    
 
79
    If output_dir is not None, topics are dumped into text files there
 
80
    during processing, as well as being included in the return result.
 
81
    """
 
82
    topics = sorted(registry.get_topics_for_section(section))
 
83
    lines = [title, hdg_level1 * len(title), ""]
 
84
 
 
85
    # docutils treats section heading as implicit link target.
 
86
    # But in some cases topic and heading are different, e.g.:
 
87
    #
 
88
    # `bugs' vs. `Bug Trackers'
 
89
    # `working-tree' vs. `Working Trees'
 
90
    #
 
91
    # So for building proper cross-reference between topic names
 
92
    # and corresponding sections in document, we need provide
 
93
    # simple glue in the form:
 
94
    #
 
95
    # .. _topic: `heading`_
 
96
    links_glue = []
 
97
 
 
98
    for topic in topics:
 
99
        help = registry.get_detail(topic)
 
100
        heading,text = help.split("\n", 1)
 
101
        lines.append(heading)
 
102
        if not text.startswith(hdg_level2):
 
103
            lines.append(hdg_level2 * len(heading))
 
104
        lines.append(text)
 
105
        lines.append('')
 
106
        # check that topic match heading
 
107
        if topic != heading.lower():
 
108
            links_glue.append((topic, heading))
 
109
        # dump the text if requested
 
110
        if output_dir is not None:
 
111
            out_file = bzrlib.osutils.pathjoin(output_dir, topic + ".txt")
 
112
            _dump_text(out_file, help)
 
113
 
 
114
    # provide links glue for topics that don't match headings
 
115
    lines.extend([".. _%s: `%s`_" % i for i in links_glue])
 
116
    lines.append('')
 
117
 
 
118
    return "\n" + "\n".join(lines) + "\n"
 
119
 
 
120
 
 
121
def _dump_text(filename, text):
 
122
    """Dump text to filename."""
 
123
    f =  open(filename, "w")
 
124
    f.writelines(text)
 
125
    f.close()
 
126
 
 
127
 
 
128
def _get_commands_section(registry, title="Commands", hdg_level1="#",
 
129
                          hdg_level2="="):
 
130
    """Build the commands reference section of the manual."""
 
131
    lines = [title, hdg_level1 * len(title), ""]
 
132
    cmds = sorted(bzrlib.commands.builtin_command_names())
 
133
    for cmd_name in cmds:
 
134
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
135
        if cmd_object.hidden:
 
136
            continue
 
137
        heading = cmd_name
 
138
        text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
 
139
        lines.append(heading)
 
140
        lines.append(hdg_level2 * len(heading))
 
141
        lines.append(text)
 
142
        lines.append('')
 
143
    return "\n" + "\n".join(lines) + "\n"
129
144
 
130
145
 
131
146
##
132
147
# TEMPLATES
133
148
 
134
 
rstx_preamble = """.. Large parts of this file are autogenerated from the output of
 
149
rstx_preamble = """.. This file is autogenerated from the output of
 
150
..     %(bzrcmd)s help topics
135
151
..     %(bzrcmd)s help commands
136
152
..     %(bzrcmd)s help <cmd>
137
153
..
138
154
.. Generation time: %(timestamp)s
139
155
 
140
 
=============================================
141
 
Man page for %(bzrcmd)s (bazaar-ng)
142
 
=============================================
143
 
 
144
 
:Date: %(datestamp)s
145
 
 
146
 
`Index <#id1>`_
 
156
"""
 
157
 
 
158
 
 
159
rstx_head = """\
 
160
#####################
 
161
Bazaar User Reference
 
162
#####################
 
163
 
 
164
:Version:   %(version)s
 
165
:Generated: %(datestamp)s
 
166
 
 
167
.. contents:: :depth: 2
147
168
 
148
169
-----
149
170
 
150
 
"""
151
 
 
152
 
 
153
 
rstx_head = """\
154
 
Name
155
 
====
156
 
%(bzrcmd)s - bazaar-ng next-generation distributed version control
157
 
 
158
 
Synopsis
159
 
========
160
 
**%(bzrcmd)s** *command* [ *command_options* ]
161
 
 
162
 
**%(bzrcmd)s help**
163
 
 
164
 
**%(bzrcmd)s help** *command*
165
 
 
166
 
 
167
 
Description
168
 
===========
169
 
bazaar-ng (or **%(bzrcmd)s**) is a project of Canonical to develop
170
 
an open source distributed version control system that is powerful,
171
 
friendly, and scalable. Version control means a system
172
 
that keeps track of previous revisions of software source code
173
 
or similar information and helps people work on it in teams.
 
171
About This Manual
 
172
#################
 
173
 
 
174
This manual is generated from Bazaar's online help. To use
 
175
the online help system, try the following commands.
 
176
 
 
177
    Introduction including a list of commonly used commands::
 
178
 
 
179
        bzr help
 
180
 
 
181
    List of topics and a summary of each::
 
182
 
 
183
        bzr help topics
 
184
 
 
185
    List of commands and a summary of each::
 
186
 
 
187
        bzr help commands
 
188
 
 
189
    More information about a particular topic or command::
 
190
 
 
191
        bzr help topic-or-command-name
 
192
 
 
193
The following web sites provide further information on Bazaar:
 
194
 
 
195
:Home page:                     http://www.bazaar-vcs.org/
 
196
:Official docs:                 http://doc.bazaar-vcs.org/
 
197
:Launchpad:                     https://launchpad.net/bzr/
174
198
"""
175
199
 
176
200
 
177
201
rstx_foot = """
178
 
Environment
179
 
===========
180
 
**BZRPATH**
181
 
                Path where **%(bzrcmd)s** is to look for external command.
182
 
 
183
 
**BZREMAIL**
184
 
                E-Mail address of the user. Overrides default user config.
185
 
 
186
 
**EMAIL**
187
 
                E-Mail address of the user. Overriddes default user config.
188
 
 
189
 
Files
190
 
=====
191
 
 
192
 
**On Linux**:  ``~/.bazaar/bazaar.conf/``
193
 
 
194
 
**On Windows**: ``C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf``
195
 
 
196
 
Contains the default user config. Only one section, ``[DEFAULT]`` is allowed.
197
 
A typical default config file may be similiar to::
198
 
 
199
 
    [DEFAULT]
200
 
    email=John Doe <jdoe@isp.com>
201
 
 
202
 
 
203
 
See also
204
 
========
205
 
http://www.bazaar-vcs.org/
206
 
 
207
 
--------------------
208
 
 
209
 
.. Contents::
210
 
        **Index**
211
202
"""