/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/doc_generate/autodoc_rstx.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 19:09:26 UTC
  • mfrom: (6622.1.36 breezy)
  • Revision ID: jelmer@jelmer.uk-20170521190926-5vtz8xaf0e9ylrpc
Merge rename to breezy.

Show diffs side-by-side

added added

removed removed

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