/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: 2020-04-05 19:11:34 UTC
  • mto: (7490.7.16 work)
  • mto: This revision was merged to the branch mainline in revision 7501.
  • Revision ID: jelmer@jelmer.uk-20200405191134-0aebh8ikiwygxma5
Populate the .gitignore file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/autodoc_rstx.py
17
17
"""Generate reStructuredText source for the User Reference Manual.
18
18
Loosely based on the manpage generator autodoc_man.py.
19
19
 
20
 
Written by the Bazaar community.
 
20
Written by the Bazaar/Breezy community.
21
21
"""
22
22
 
23
 
import os
24
 
import sys
 
23
from __future__ import absolute_import
 
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):
41
41
    t = time.time()
42
42
    tt = time.gmtime(t)
43
43
    params = \
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
 
             }
 
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__,
 
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 = bzrlib.osutils.dirname(nominated_filename)
 
53
        topic_dir = breezy.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 bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
63
 
    registry = bzrlib.help_topics.topic_registry
 
62
    from breezy.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
 
63
    registry = breezy.help_topics.topic_registry
64
64
    result = []
65
65
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
66
 
        output_dir=topic_dir))
 
66
                               output_dir=topic_dir))
67
67
    result.append(_get_section(registry, SECT_LIST, "Lists",
68
 
        output_dir=topic_dir))
 
68
                               output_dir=topic_dir))
69
69
    result.append(_get_commands_section(registry, output_dir=topic_dir))
70
70
    return "\n".join(result)
71
71
 
72
72
 
73
73
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
74
 
        output_dir=None):
 
74
                 output_dir=None):
75
75
    """Build the manual part from topics matching that section.
76
 
    
 
76
 
77
77
    If output_dir is not None, topics are dumped into text files there
78
78
    during processing, as well as being included in the return result.
79
79
    """
101
101
 
102
102
 
103
103
def _get_commands_section(registry, title="Commands", hdg_level1="#",
104
 
        hdg_level2="=", output_dir=None):
 
104
                          hdg_level2="=", output_dir=None):
105
105
    """Build the commands reference section of the manual."""
106
106
    file_per_topic = output_dir is not None
107
107
    lines = [title, hdg_level1 * len(title), ""]
108
108
    if file_per_topic:
109
109
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
110
110
 
111
 
    cmds = sorted(bzrlib.commands.builtin_command_names())
 
111
    cmds = sorted(breezy.commands.builtin_command_names())
112
112
    for cmd_name in cmds:
113
 
        cmd_object = bzrlib.commands.get_cmd_object(cmd_name)
 
113
        cmd_object = breezy.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 = bzrlib.osutils.pathjoin(output_dir, topic_id + ".txt")
133
 
    f =  open(filename, "w")
134
 
    f.writelines(text)
135
 
    f.close()
 
132
    filename = breezy.osutils.pathjoin(output_dir, topic_id + ".txt")
 
133
    with open(filename, "wb") as f:
 
134
        f.write(text.encode('utf-8'))
136
135
    return topic_id
137
136
 
138
137
 
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
 
.. Generation time: %(timestamp)s
148
146
 
149
147
"""
150
148
 
151
149
 
152
150
rstx_head = """\
153
151
#####################
154
 
Bazaar User Reference
 
152
Breezy User Reference
155
153
#####################
156
154
 
157
155
About This Manual
158
156
#################
159
157
 
160
 
This manual is generated from Bazaar's online help. To use
 
158
This manual is generated from Breezy's online help. To use
161
159
the online help system, try the following commands.
162
160
 
163
161
    Introduction including a list of commonly used commands::
164
162
 
165
 
        bzr help
 
163
        brz help
166
164
 
167
165
    List of topics and a summary of each::
168
166
 
169
 
        bzr help topics
 
167
        brz help topics
170
168
 
171
169
    List of commands and a summary of each::
172
170
 
173
 
        bzr help commands
 
171
        brz help commands
174
172
 
175
173
    More information about a particular topic or command::
176
174
 
177
 
        bzr help topic-or-command-name
178
 
 
179
 
The following web sites provide further information on Bazaar:
180
 
 
181
 
:Home page:                     http://bazaar.canonical.com/
182
 
:Official docs:                 http://doc.bazaar.canonical.com/
183
 
:Launchpad:                     https://launchpad.net/bzr/
 
175
        brz help topic-or-command-name
 
176
 
 
177
The following web sites provide further information on Breezy:
 
178
 
 
179
:Home page:                     http://www.breezy-vcs.org/
 
180
:Breezy docs:                   http://www.breezy-vcs.org/doc/
 
181
:Launchpad:                     https://launchpad.net/brz/
184
182
"""
185
183
 
186
184