← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/doc_generate/autodoc_rstx.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-29 22:03:03 UTC
  • mfrom: (5416.2.6 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100929220303-cr95h8iwtggco721
(mbp) Add 'break-lock --force'

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/doc_generate/autodoc_rstx.py
 
1
# Copyright (C) 2006-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
"""Generate reStructuredText source for the User Reference Manual.
 
18
Loosely based on the manpage generator autodoc_man.py.
 
19
 
 
20
Written by the Bazaar community.
 
21
"""
 
22
 
 
23
import os
 
24
import sys
 
25
import time
 
26
 
 
27
import bzrlib
 
28
import bzrlib.help
 
29
import bzrlib.help_topics
 
30
import bzrlib.commands
 
31
import bzrlib.osutils
 
32
 
 
33
 
 
34
def get_filename(options):
 
35
    """Provides name of manual"""
 
36
    return "%s_man.txt" % (options.bzr_name)
 
37
 
 
38
 
 
39
def infogen(options, outfile):
 
40
    """Create manual in RSTX format"""
 
41
    t = time.time()
 
42
    tt = time.gmtime(t)
 
43
    params = \
 
44
           { "bzrcmd": options.bzr_name,
 
45
             "datestamp": time.strftime("%Y-%m-%d",tt),
 
46
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
 
47
             "version": bzrlib.__version__,
 
48
             }
 
49
    nominated_filename = getattr(options, 'filename', None)
 
50
    if nominated_filename is None:
 
51
        topic_dir = None
 
52
    else:
 
53
        topic_dir = bzrlib.osutils.dirname(nominated_filename)
 
54
    outfile.write(rstx_preamble % params)
 
55
    outfile.write(rstx_head % params)
 
56
    outfile.write(_get_body(params, topic_dir))
 
57
    outfile.write(rstx_foot % params)
 
58
 
 
59
 
 
60
def _get_body(params, topic_dir):
 
61
    """Build the manual content."""
 
62
    from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
 
63
    registry = bzrlib.help_topics.topic_registry
 
64
    result = []
 
65
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
 
66
        output_dir=topic_dir))
 
67
    result.append(_get_section(registry, SECT_LIST, "Lists",
 
68
        output_dir=topic_dir))
 
69
    result.append(_get_commands_section(registry, output_dir=topic_dir))
 
70
    return "\n".join(result)
 
71
 
 
72
 
 
73
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
 
74
        output_dir=None):
 
75
    """Build the manual part from topics matching that section.
 
76
    
 
77
    If output_dir is not None, topics are dumped into text files there
 
78
    during processing, as well as being included in the return result.
 
79
    """
 
80
    file_per_topic = output_dir is not None
 
81
    lines = [title, hdg_level1 * len(title), ""]
 
82
    if file_per_topic:
 
83
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
 
84
 
 
85
    topics = sorted(registry.get_topics_for_section(section))
 
86
    for topic in topics:
 
87
        help = registry.get_detail(topic)
 
88
        heading, text = help.split("\n", 1)
 
89
        if not text.startswith(hdg_level2):
 
90
            underline = hdg_level2 * len(heading)
 
91
            help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
 
92
        else:
 
93
            help = "%s\n%s\n\n" % (heading, text)
 
94
        if file_per_topic:
 
95
            topic_id = _dump_text(output_dir, topic, help)
 
96
            lines.append("   %s" % topic_id)
 
97
        else:
 
98
            lines.append(help)
 
99
 
 
100
    return "\n" + "\n".join(lines) + "\n"
 
101
 
 
102
 
 
103
def _get_commands_section(registry, title="Commands", hdg_level1="#",
 
104
        hdg_level2="=", output_dir=None):
 
105
    """Build the commands reference section of the manual."""
 
106
    file_per_topic = output_dir is not None
 
107
    lines = [title, hdg_level1 * len(title), ""]
 
108
    if file_per_topic:
 
109
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
 
110
 
 
111
    cmds = sorted(bzrlib.commands.builtin_command_names())
 
112
    for cmd_name in cmds:
 
113
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
114
        if cmd_object.hidden:
 
115
            continue
 
116
        heading = cmd_name
 
117
        underline = hdg_level2 * len(heading)
 
118
        text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
 
119
        help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
 
120
        if file_per_topic:
 
121
            topic_id = _dump_text(output_dir, cmd_name, help)
 
122
            lines.append("   %s" % topic_id)
 
123
        else:
 
124
            lines.append(help)
 
125
 
 
126
    return "\n" + "\n".join(lines) + "\n"
 
127
 
 
128
 
 
129
def _dump_text(output_dir, topic, text):
 
130
    """Dump text for a topic to a file."""
 
131
    topic_id = "%s-%s" % (topic, "help")
 
132
    filename = bzrlib.osutils.pathjoin(output_dir, topic_id + ".txt")
 
133
    f =  open(filename, "w")
 
134
    f.writelines(text)
 
135
    f.close()
 
136
    return topic_id
 
137
 
 
138
 
 
139
##
 
140
# TEMPLATES
 
141
 
 
142
rstx_preamble = """.. This file is autogenerated from the output of
 
143
..     %(bzrcmd)s help topics
 
144
..     %(bzrcmd)s help commands
 
145
..     %(bzrcmd)s help <cmd>
 
146
..
 
147
.. Generation time: %(timestamp)s
 
148
 
 
149
"""
 
150
 
 
151
 
 
152
rstx_head = """\
 
153
#####################
 
154
Bazaar User Reference
 
155
#####################
 
156
 
 
157
About This Manual
 
158
#################
 
159
 
 
160
This manual is generated from Bazaar's online help. To use
 
161
the online help system, try the following commands.
 
162
 
 
163
    Introduction including a list of commonly used commands::
 
164
 
 
165
        bzr help
 
166
 
 
167
    List of topics and a summary of each::
 
168
 
 
169
        bzr help topics
 
170
 
 
171
    List of commands and a summary of each::
 
172
 
 
173
        bzr help commands
 
174
 
 
175
    More information about a particular topic or command::
 
176
 
 
177
        bzr help topic-or-command-name
 
178
 
 
179
The following web sites provide further information on Bazaar:
 
180
 
 
181
:Home page:                     http://bazaar.canonical.com/
 
182
:Official docs:                 http://doc.bazaar.canonical.com/
 
183
:Launchpad:                     https://launchpad.net/bzr/
 
184
"""
 
185
 
 
186
 
 
187
rstx_foot = """
 
188
"""