← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to tools/doc_generate/autodoc_rstx.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-04 18:51:39 UTC
  • mfrom: (2961.1.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20071104185139-kaio3sneodg2kp71
Authentication ring implementation (read-only)

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/doc_generate/autodoc_rstx.py
29
29
import bzrlib.help
30
30
import bzrlib.help_topics
31
31
import bzrlib.commands
32
 
import bzrlib.osutils
33
32
 
34
33
 
35
34
def get_filename(options):
47
46
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
48
47
             "version": bzrlib.__version__,
49
48
             }
50
 
    nominated_filename = getattr(options, 'filename', None)
51
 
    if nominated_filename is None:
52
 
        topic_dir = None
53
 
    else:
54
 
        topic_dir = bzrlib.osutils.dirname(nominated_filename)
55
49
    outfile.write(rstx_preamble % params)
56
50
    outfile.write(rstx_head % params)
57
 
    outfile.write(_get_body(params, topic_dir))
 
51
    outfile.write(_get_body(params))
58
52
    outfile.write(rstx_foot % params)
59
53
 
60
54
 
61
 
def _get_body(params, topic_dir):
 
55
def _get_body(params):
62
56
    """Build the manual content."""
63
57
    from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
64
58
    registry = bzrlib.help_topics.topic_registry
65
59
    result = []
66
 
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
67
 
        output_dir=topic_dir))
68
 
    result.append(_get_section(registry, SECT_LIST, "Lists",
69
 
        output_dir=topic_dir))
 
60
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts"))
 
61
    result.append(_get_section(registry, SECT_LIST, "Lists"))
70
62
    result.append(_get_commands_section(registry))
71
 
    #result.append(_get_section(registry, SECT_PLUGIN, "Standard Plug-ins"))
 
63
    #result.append(_get_section(registry, SECT_PLUGIN, "Core Plug-ins"))
72
64
    return "\n".join(result)
73
65
 
74
66
 
75
 
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
76
 
        output_dir=None):
77
 
    """Build the manual part from topics matching that section.
78
 
    
79
 
    If output_dir is not None, topics are dumped into text files there
80
 
    during processing, as well as being included in the return result.
81
 
    """
 
67
def _get_section(registry, section, title, hdg_level1="=", hdg_level2="-"):
 
68
    """Build the manual part from topics matching that section."""
82
69
    topics = sorted(registry.get_topics_for_section(section))
83
70
    lines = [title, hdg_level1 * len(title), ""]
84
71
 
99
86
        help = registry.get_detail(topic)
100
87
        heading,text = help.split("\n", 1)
101
88
        lines.append(heading)
102
 
        if not text.startswith(hdg_level2):
103
 
            lines.append(hdg_level2 * len(heading))
 
89
        lines.append(hdg_level2 * len(heading))
104
90
        lines.append(text)
105
91
        lines.append('')
106
92
        # check that topic match heading
107
93
        if topic != heading.lower():
108
94
            links_glue.append((topic, heading))
109
 
        # dump the text if requested
110
 
        if output_dir is not None:
111
 
            out_file = bzrlib.osutils.pathjoin(output_dir, topic + ".txt")
112
 
            _dump_text(out_file, help)
113
95
 
114
96
    # provide links glue for topics that don't match headings
115
97
    lines.extend([".. _%s: `%s`_" % i for i in links_glue])
118
100
    return "\n" + "\n".join(lines) + "\n"
119
101
 
120
102
 
121
 
def _dump_text(filename, text):
122
 
    """Dump text to filename."""
123
 
    f =  open(filename, "w")
124
 
    f.writelines(text)
125
 
    f.close()
126
 
 
127
 
 
128
 
def _get_commands_section(registry, title="Commands", hdg_level1="#",
129
 
                          hdg_level2="="):
130
 
    """Build the commands reference section of the manual."""
 
103
def _get_commands_section(registry, title="Commands", hdg_level1="=",
 
104
                          hdg_level2="-"):
 
105
    """Build the comands reference section of the manual."""
131
106
    lines = [title, hdg_level1 * len(title), ""]
132
107
    cmds = sorted(bzrlib.commands.builtin_command_names())
133
108
    for cmd_name in cmds:
157
132
 
158
133
 
159
134
rstx_head = """\
160
 
#####################
 
135
=====================
161
136
Bazaar User Reference
162
 
#####################
 
137
=====================
163
138
 
164
139
:Version:   %(version)s
165
140
:Generated: %(datestamp)s
166
141
 
167
 
.. contents:: :depth: 2
 
142
.. contents::
168
143
 
169
144
-----
170
145
 
171
146
About This Manual
172
 
#################
 
147
=================
173
148
 
174
149
This manual is generated from Bazaar's online help. To use
175
150
the online help system, try the following commands.