/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 bzrlib/doc_generate/autodoc_rstx.py

  • Committer: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

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