46
46
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
47
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
49
outfile.write(rstx_preamble % params)
55
50
outfile.write(rstx_head % params)
56
outfile.write(_get_body(params, topic_dir))
51
outfile.write(_get_body(params))
57
52
outfile.write(rstx_foot % params)
60
def _get_body(params, topic_dir):
55
def _get_body(params):
61
56
"""Build the manual content."""
62
57
from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
63
58
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, output_dir=topic_dir))
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"))
70
64
return "\n".join(result)
73
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
75
"""Build the manual part from topics matching that section.
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.
80
file_per_topic = output_dir is not None
81
lines = [title, hdg_level1 * len(title), ""]
83
lines.extend([".. toctree::", " :maxdepth: 1", ""])
67
def _get_section(registry, section, title, hdg_level1="=", hdg_level2="-"):
68
"""Build the manual part from topics matching that section."""
85
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
85
for topic in topics:
87
86
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)
93
help = "%s\n%s\n\n" % (heading, text)
95
topic_id = _dump_text(output_dir, topic, help)
96
lines.append(" %s" % topic_id)
87
heading,text = help.split("\n", 1)
89
lines.append(hdg_level2 * len(heading))
92
# check that topic match heading
93
if topic != heading.lower():
94
links_glue.append((topic, heading))
96
# provide links glue for topics that don't match headings
97
lines.extend([".. _%s: `%s`_" % i for i in links_glue])
100
100
return "\n" + "\n".join(lines) + "\n"
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
103
def _get_commands_section(registry, title="Commands", hdg_level1="=",
105
"""Build the comands reference section of the manual."""
107
106
lines = [title, hdg_level1 * len(title), ""]
109
lines.extend([".. toctree::", " :maxdepth: 1", ""])
111
107
cmds = sorted(bzrlib.commands.builtin_command_names())
112
108
for cmd_name in cmds:
113
109
cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
114
110
if cmd_object.hidden:
116
112
heading = cmd_name
117
underline = hdg_level2 * len(heading)
118
113
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)
121
topic_id = _dump_text(output_dir, cmd_name, help)
122
lines.append(" %s" % topic_id)
114
lines.append(heading)
115
lines.append(hdg_level2 * len(heading))
126
118
return "\n" + "\n".join(lines) + "\n"
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")