/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

Viewing changes to breezy/doc_generate/autodoc_rstx.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
 
25
25
import time
26
26
 
27
 
import bzrlib
28
 
import bzrlib.help
29
 
import bzrlib.help_topics
30
 
import bzrlib.commands
31
 
import bzrlib.osutils
 
27
import breezy
 
28
import breezy.help
 
29
import breezy.help_topics
 
30
import breezy.commands
 
31
import breezy.osutils
32
32
 
33
33
 
34
34
def get_filename(options):
35
35
    """Provides name of manual"""
36
 
    return "%s_man.txt" % (options.bzr_name)
 
36
    return "%s_man.txt" % (options.brz_name)
37
37
 
38
38
 
39
39
def infogen(options, outfile):
40
40
    """Create manual in RSTX format"""
41
 
    t = time.time()
42
 
    tt = time.gmtime(t)
 
41
    tt = breezy.osutils.gmtime()
43
42
    params = \
44
 
           { "bzrcmd": options.bzr_name,
 
43
           { "brzcmd": options.brz_name,
45
44
             "datestamp": time.strftime("%Y-%m-%d",tt),
46
45
             "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
47
 
             "version": bzrlib.__version__,
 
46
             "version": breezy.__version__,
48
47
             }
49
48
    nominated_filename = getattr(options, 'filename', None)
50
49
    if nominated_filename is None:
51
50
        topic_dir = None
52
51
    else:
53
 
        topic_dir = bzrlib.osutils.dirname(nominated_filename)
 
52
        topic_dir = breezy.osutils.dirname(nominated_filename)
54
53
    outfile.write(rstx_preamble % params)
55
54
    outfile.write(rstx_head % params)
56
55
    outfile.write(_get_body(params, topic_dir))
59
58
 
60
59
def _get_body(params, topic_dir):
61
60
    """Build the manual content."""
62
 
    from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
63
 
    registry = bzrlib.help_topics.topic_registry
 
61
    from breezy.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
 
62
    registry = breezy.help_topics.topic_registry
64
63
    result = []
65
64
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
66
65
        output_dir=topic_dir))
108
107
    if file_per_topic:
109
108
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
110
109
 
111
 
    cmds = sorted(bzrlib.commands.builtin_command_names())
 
110
    cmds = sorted(breezy.commands.builtin_command_names())
112
111
    for cmd_name in cmds:
113
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
112
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
114
113
        if cmd_object.hidden:
115
114
            continue
116
115
        heading = cmd_name
129
128
def _dump_text(output_dir, topic, text):
130
129
    """Dump text for a topic to a file."""
131
130
    topic_id = "%s-%s" % (topic, "help")
132
 
    filename = bzrlib.osutils.pathjoin(output_dir, topic_id + ".txt")
 
131
    filename = breezy.osutils.pathjoin(output_dir, topic_id + ".txt")
133
132
    f =  open(filename, "w")
134
133
    f.write(text.encode('utf-8'))
135
134
    f.close()
140
139
# TEMPLATES
141
140
 
142
141
rstx_preamble = """.. This file is autogenerated from the output of
143
 
..     %(bzrcmd)s help topics
144
 
..     %(bzrcmd)s help commands
145
 
..     %(bzrcmd)s help <cmd>
 
142
..     %(brzcmd)s help topics
 
143
..     %(brzcmd)s help commands
 
144
..     %(brzcmd)s help <cmd>
146
145
..
147
146
 
148
147
"""
161
160
 
162
161
    Introduction including a list of commonly used commands::
163
162
 
164
 
        bzr help
 
163
        brz help
165
164
 
166
165
    List of topics and a summary of each::
167
166
 
168
 
        bzr help topics
 
167
        brz help topics
169
168
 
170
169
    List of commands and a summary of each::
171
170
 
172
 
        bzr help commands
 
171
        brz help commands
173
172
 
174
173
    More information about a particular topic or command::
175
174
 
176
 
        bzr help topic-or-command-name
 
175
        brz help topic-or-command-name
177
176
 
178
177
The following web sites provide further information on Bazaar:
179
178
 
180
179
:Home page:                     http://bazaar.canonical.com/
181
 
:Official docs:                 http://doc.bazaar.canonical.com/
182
 
:Launchpad:                     https://launchpad.net/bzr/
 
180
:Bazaar docs:                   http://doc.bazaar.canonical.com/
 
181
:Launchpad:                     https://launchpad.net/brz/
183
182
"""
184
183
 
185
184