1
# Copyright (C) 2006-2007 Canonical Ltd
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.
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.
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
17
"""Generate reStructuredText source for the User Reference Manual.
18
Loosely based on the manpage generator autodoc_man.py.
20
Written by the Bazaar community.
29
import bzrlib.help_topics
30
import bzrlib.commands
34
# Set this to True to generate a file per topic.
35
# This probably ought to be an option. The files probably
36
# ought to be prefixed with their section name as well so
37
# there's zero risk of clashing with a standard sphinx
38
# topic (like search.html).
42
def get_filename(options):
43
"""Provides name of manual"""
44
return "%s_man.txt" % (options.bzr_name)
47
def infogen(options, outfile):
48
"""Create manual in RSTX format"""
52
{ "bzrcmd": options.bzr_name,
53
"datestamp": time.strftime("%Y-%m-%d",tt),
54
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
55
"version": bzrlib.__version__,
57
nominated_filename = getattr(options, 'filename', None)
58
if nominated_filename is None:
61
topic_dir = bzrlib.osutils.dirname(nominated_filename)
62
outfile.write(rstx_preamble % params)
63
outfile.write(rstx_head % params)
64
outfile.write(_get_body(params, topic_dir))
65
outfile.write(rstx_foot % params)
68
def _get_body(params, topic_dir):
69
"""Build the manual content."""
70
from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
71
registry = bzrlib.help_topics.topic_registry
73
result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
74
output_dir=topic_dir))
75
result.append(_get_section(registry, SECT_LIST, "Lists",
76
output_dir=topic_dir))
77
result.append(_get_commands_section(registry, output_dir=topic_dir))
78
return "\n".join(result)
81
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
83
"""Build the manual part from topics matching that section.
85
If output_dir is not None, topics are dumped into text files there
86
during processing, as well as being included in the return result.
88
lines = [title, hdg_level1 * len(title), ""]
90
lines.extend([".. toctree::", " :maxdepth: 1", ""])
92
# docutils treats section heading as implicit link target.
93
# But in some cases topic and heading are different, e.g.:
95
# `bugs' vs. `Bug Trackers'
96
# `working-tree' vs. `Working Trees'
98
# So for building proper cross-reference between topic names
99
# and corresponding sections in document, we need provide
100
# simple glue in the form:
102
# .. _topic: `heading`_
105
topics = sorted(registry.get_topics_for_section(section))
107
help = registry.get_detail(topic)
108
heading, text = help.split("\n", 1)
109
if not text.startswith(hdg_level2):
110
underline = hdg_level2 * len(heading)
111
help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
113
help = "%s\n%s\n\n" % (heading, text)
115
topic_id = _dump_text(output_dir, topic, help)
116
lines.append(" %s" % topic_id)
120
# check that topic match heading
121
if topic != heading.lower():
122
links_glue.append((topic, heading))
124
# provide links glue for topics that don't match headings
126
#lines.extend([".. _%s: `%s`_" % i for i in links_glue])
129
return "\n" + "\n".join(lines) + "\n"
132
def _get_commands_section(registry, title="Commands", hdg_level1="#",
133
hdg_level2="=", output_dir=None):
134
"""Build the commands reference section of the manual."""
135
lines = [title, hdg_level1 * len(title), ""]
137
lines.extend([".. toctree::", " :maxdepth: 1", ""])
139
cmds = sorted(bzrlib.commands.builtin_command_names())
140
for cmd_name in cmds:
141
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
142
if cmd_object.hidden:
145
underline = hdg_level2 * len(heading)
146
text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
147
help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
149
topic_id = _dump_text(output_dir, cmd_name, help)
150
lines.append(" %s" % topic_id)
154
return "\n" + "\n".join(lines) + "\n"
157
def _dump_text(output_dir, topic, text):
158
"""Dump text for a topic to a file."""
159
topic_id = "%s-%s" % (topic, "help")
160
filename = bzrlib.osutils.pathjoin(output_dir, topic_id + ".txt")
161
f = open(filename, "w")
170
rstx_preamble = """.. This file is autogenerated from the output of
171
.. %(bzrcmd)s help topics
172
.. %(bzrcmd)s help commands
173
.. %(bzrcmd)s help <cmd>
175
.. Generation time: %(timestamp)s
181
#####################
182
Bazaar User Reference
183
#####################
188
This manual is generated from Bazaar's online help. To use
189
the online help system, try the following commands.
191
Introduction including a list of commonly used commands::
195
List of topics and a summary of each::
199
List of commands and a summary of each::
203
More information about a particular topic or command::
205
bzr help topic-or-command-name
207
The following web sites provide further information on Bazaar:
209
:Home page: http://bazaar.canonical.com/
210
:Official docs: http://doc.bazaar.canonical.com/
211
:Launchpad: https://launchpad.net/bzr/
added
removed
bzrlib/doc_generate/autodoc_rstx.py
