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
def get_filename(options):
35
"""Provides name of manual"""
36
return "%s_man.txt" % (options.bzr_name)
39
def infogen(options, outfile):
40
"""Create manual in RSTX format"""
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__,
49
nominated_filename = getattr(options, 'filename', None)
50
if nominated_filename is None:
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)
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
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))
70
#result.append(_get_section(registry, SECT_PLUGIN, "Standard Plug-ins"))
71
return "\n".join(result)
74
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
76
"""Build the manual part from topics matching that section.
78
If output_dir is not None, topics are dumped into text files there
79
during processing, as well as being included in the return result.
81
topics = sorted(registry.get_topics_for_section(section))
82
lines = [title, hdg_level1 * len(title), ""]
84
# docutils treats section heading as implicit link target.
85
# But in some cases topic and heading are different, e.g.:
87
# `bugs' vs. `Bug Trackers'
88
# `working-tree' vs. `Working Trees'
90
# So for building proper cross-reference between topic names
91
# and corresponding sections in document, we need provide
92
# simple glue in the form:
94
# .. _topic: `heading`_
98
help = registry.get_detail(topic)
99
heading,text = help.split("\n", 1)
100
lines.append(heading)
101
if not text.startswith(hdg_level2):
102
lines.append(hdg_level2 * len(heading))
105
# check that topic match heading
106
if topic != heading.lower():
107
links_glue.append((topic, heading))
108
# dump the text if requested
109
if output_dir is not None:
110
out_file = bzrlib.osutils.pathjoin(output_dir, topic + ".txt")
111
_dump_text(out_file, help)
113
# provide links glue for topics that don't match headings
114
lines.extend([".. _%s: `%s`_" % i for i in links_glue])
117
return "\n" + "\n".join(lines) + "\n"
120
def _dump_text(filename, text):
121
"""Dump text to filename."""
122
f = open(filename, "w")
127
def _get_commands_section(registry, title="Commands", hdg_level1="#",
129
"""Build the commands reference section of the manual."""
130
lines = [title, hdg_level1 * len(title), ""]
131
cmds = sorted(bzrlib.commands.builtin_command_names())
132
for cmd_name in cmds:
133
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
134
if cmd_object.hidden:
137
text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
138
lines.append(heading)
139
lines.append(hdg_level2 * len(heading))
142
return "\n" + "\n".join(lines) + "\n"
148
rstx_preamble = """.. This file is autogenerated from the output of
149
.. %(bzrcmd)s help topics
150
.. %(bzrcmd)s help commands
151
.. %(bzrcmd)s help <cmd>
153
.. Generation time: %(timestamp)s
159
#####################
160
Bazaar User Reference
161
#####################
163
:Version: %(version)s
164
:Generated: %(datestamp)s
166
.. contents:: :depth: 2
173
This manual is generated from Bazaar's online help. To use
174
the online help system, try the following commands.
176
Introduction including a list of commonly used commands::
180
List of topics and a summary of each::
184
List of commands and a summary of each::
188
More information about a particular topic or command::
190
bzr help topic-or-command-name
192
The following web sites provide further information on Bazaar:
194
:Home page: http://www.bazaar-vcs.org/
195
:Official docs: http://doc.bazaar-vcs.org/
196
:Launchpad: https://launchpad.net/bzr/
added
removed
bzrlib/doc_generate/autodoc_rstx.py
