1
# Copyright 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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.
30
import bzrlib.help_topics
31
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
outfile.write(rstx_preamble % params)
50
outfile.write(rstx_head % params)
51
outfile.write(_get_body(params))
52
outfile.write(rstx_foot % params)
55
def _get_body(params):
56
"""Build the manual content."""
57
from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
58
registry = bzrlib.help_topics.topic_registry
60
result.append(_get_section(registry, SECT_CONCEPT, "Concepts"))
61
result.append(_get_section(registry, SECT_LIST, "Lists"))
62
result.append(_get_commands_section(registry))
63
#result.append(_get_section(registry, SECT_PLUGIN, "Core Plug-ins"))
64
return "\n".join(result)
67
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="="):
68
"""Build the manual part from topics matching that section."""
69
topics = sorted(registry.get_topics_for_section(section))
70
lines = [title, hdg_level1 * len(title), ""]
72
# docutils treats section heading as implicit link target.
73
# But in some cases topic and heading are different, e.g.:
75
# `bugs' vs. `Bug Trackers'
76
# `working-tree' vs. `Working Trees'
78
# So for building proper cross-reference between topic names
79
# and corresponding sections in document, we need provide
80
# simple glue in the form:
82
# .. _topic: `heading`_
86
help = registry.get_detail(topic)
87
heading,text = help.split("\n", 1)
89
if not text.startswith(hdg_level2):
90
lines.append(hdg_level2 * len(heading))
93
# check that topic match heading
94
if topic != heading.lower():
95
links_glue.append((topic, heading))
97
# provide links glue for topics that don't match headings
98
lines.extend([".. _%s: `%s`_" % i for i in links_glue])
101
return "\n" + "\n".join(lines) + "\n"
104
def _get_commands_section(registry, title="Commands", hdg_level1="#",
106
"""Build the comands reference section of the manual."""
107
lines = [title, hdg_level1 * len(title), ""]
108
cmds = sorted(bzrlib.commands.builtin_command_names())
109
for cmd_name in cmds:
110
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
111
if cmd_object.hidden:
114
text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
115
lines.append(heading)
116
lines.append(hdg_level2 * len(heading))
119
return "\n" + "\n".join(lines) + "\n"
125
rstx_preamble = """.. This file is autogenerated from the output of
126
.. %(bzrcmd)s help topics
127
.. %(bzrcmd)s help commands
128
.. %(bzrcmd)s help <cmd>
130
.. Generation time: %(timestamp)s
136
#####################
137
Bazaar User Reference
138
#####################
140
:Version: %(version)s
141
:Generated: %(datestamp)s
143
.. contents:: :depth: 2
150
This manual is generated from Bazaar's online help. To use
151
the online help system, try the following commands.
153
Introduction including a list of commonly used commands::
157
List of topics and a summary of each::
161
List of commands and a summary of each::
165
More information about a particular topic or command::
167
bzr help topic-or-command-name
169
The following web sites provide further information on Bazaar:
171
:Home page: http://www.bazaar-vcs.org/
172
:Official docs: http://doc.bazaar-vcs.org/
173
:Launchpad: https://launchpad.net/bzr/
added
removed
tools/doc_generate/autodoc_rstx.py
