~bzr-pqm/bzr/bzr.dev

fixes after John's review

added added

removed removed

"""Generate ReStructuredText source for the User Reference Manual.

Loosely based on the manpage generator autodoc_man.py.

Written by Bazaar community.

Written by the Bazaar community.

"""

import os

"""Build the manual part from topics matching that section."""

topics = sorted(registry.get_topics_for_section(section))

lines = [title, hdg_level1 * len(title), ""]

links_to_topics = []

# docutils treats section heading as implicit link target.

# But in some cases topic and heading are different, e.g.:

# `bugs' vs. `Bug Trackers'

# `working-tree' vs. `Working Trees'

# So for building proper cross-reference between topic names

# and corresponding sections in document, we need provide

# simple glue in the form:

# .. _topic: `heading`_

links_glue = []

for topic in topics:

help = registry.get_detail(topic)

heading,text = help.split("\n", 1)

lines.append(hdg_level2 * len(heading))

lines.append(text)

lines.append('')

# check that topic match heading

if topic != heading.lower():

links_to_topics.append((topic, heading))

lines.extend([".. _%s: `%s`_" % i for i in links_to_topics])

links_glue.append((topic, heading))

# provide links glue for topics that don't match headings

lines.extend([".. _%s: `%s`_" % i for i in links_glue])

lines.append('')

100

return "\n" + "\n".join(lines) + "\n"

101

102