/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-05-24 00:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 7504.
  • Revision ID: jelmer@jelmer.uk-20200524003950-bbc545r76vc5yajg
Add github action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/doc_generate/autodoc_rstx.py
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""Generate reStructuredText source for the User Reference Manual.
 
18
Loosely based on the manpage generator autodoc_man.py.
 
19
 
 
20
Written by the Bazaar/Breezy community.
 
21
"""
 
22
 
 
23
import time
 
24
 
 
25
import breezy
 
26
import breezy.help
 
27
import breezy.help_topics
 
28
import breezy.commands
 
29
import breezy.osutils
 
30
 
 
31
 
 
32
def get_filename(options):
 
33
    """Provides name of manual"""
 
34
    return "%s_man.txt" % (options.brz_name)
 
35
 
 
36
 
 
37
def infogen(options, outfile):
 
38
    """Create manual in RSTX format"""
 
39
    t = time.time()
 
40
    tt = time.gmtime(t)
 
41
    params = \
 
42
        {"brzcmd": options.brz_name,
 
43
         "datestamp": time.strftime("%Y-%m-%d", tt),
 
44
         "timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000", tt),
 
45
         "version": breezy.__version__,
 
46
         }
 
47
    nominated_filename = getattr(options, 'filename', None)
 
48
    if nominated_filename is None:
 
49
        topic_dir = None
 
50
    else:
 
51
        topic_dir = breezy.osutils.dirname(nominated_filename)
 
52
    outfile.write(rstx_preamble % params)
 
53
    outfile.write(rstx_head % params)
 
54
    outfile.write(_get_body(params, topic_dir))
 
55
    outfile.write(rstx_foot % params)
 
56
 
 
57
 
 
58
def _get_body(params, topic_dir):
 
59
    """Build the manual content."""
 
60
    from breezy.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
 
61
    registry = breezy.help_topics.topic_registry
 
62
    result = []
 
63
    result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
 
64
                               output_dir=topic_dir))
 
65
    result.append(_get_section(registry, SECT_LIST, "Lists",
 
66
                               output_dir=topic_dir))
 
67
    result.append(_get_commands_section(registry, output_dir=topic_dir))
 
68
    return "\n".join(result)
 
69
 
 
70
 
 
71
def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
 
72
                 output_dir=None):
 
73
    """Build the manual part from topics matching that section.
 
74
 
 
75
    If output_dir is not None, topics are dumped into text files there
 
76
    during processing, as well as being included in the return result.
 
77
    """
 
78
    file_per_topic = output_dir is not None
 
79
    lines = [title, hdg_level1 * len(title), ""]
 
80
    if file_per_topic:
 
81
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
 
82
 
 
83
    topics = sorted(registry.get_topics_for_section(section))
 
84
    for topic in topics:
 
85
        help = registry.get_detail(topic)
 
86
        heading, text = help.split("\n", 1)
 
87
        if not text.startswith(hdg_level2):
 
88
            underline = hdg_level2 * len(heading)
 
89
            help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
 
90
        else:
 
91
            help = "%s\n%s\n\n" % (heading, text)
 
92
        if file_per_topic:
 
93
            topic_id = _dump_text(output_dir, topic, help)
 
94
            lines.append("   %s" % topic_id)
 
95
        else:
 
96
            lines.append(help)
 
97
 
 
98
    return "\n" + "\n".join(lines) + "\n"
 
99
 
 
100
 
 
101
def _get_commands_section(registry, title="Commands", hdg_level1="#",
 
102
                          hdg_level2="=", output_dir=None):
 
103
    """Build the commands reference section of the manual."""
 
104
    file_per_topic = output_dir is not None
 
105
    lines = [title, hdg_level1 * len(title), ""]
 
106
    if file_per_topic:
 
107
        lines.extend([".. toctree::", "   :maxdepth: 1", ""])
 
108
 
 
109
    cmds = sorted(breezy.commands.builtin_command_names())
 
110
    for cmd_name in cmds:
 
111
        cmd_object = breezy.commands.get_cmd_object(cmd_name)
 
112
        if cmd_object.hidden:
 
113
            continue
 
114
        heading = cmd_name
 
115
        underline = hdg_level2 * len(heading)
 
116
        text = cmd_object.get_help_text(plain=False, see_also_as_links=True)
 
117
        help = "%s\n%s\n\n%s\n\n" % (heading, underline, text)
 
118
        if file_per_topic:
 
119
            topic_id = _dump_text(output_dir, cmd_name, help)
 
120
            lines.append("   %s" % topic_id)
 
121
        else:
 
122
            lines.append(help)
 
123
 
 
124
    return "\n" + "\n".join(lines) + "\n"
 
125
 
 
126
 
 
127
def _dump_text(output_dir, topic, text):
 
128
    """Dump text for a topic to a file."""
 
129
    topic_id = "%s-%s" % (topic, "help")
 
130
    filename = breezy.osutils.pathjoin(output_dir, topic_id + ".txt")
 
131
    with open(filename, "wb") as f:
 
132
        f.write(text.encode('utf-8'))
 
133
    return topic_id
 
134
 
 
135
 
 
136
##
 
137
# TEMPLATES
 
138
 
 
139
rstx_preamble = """.. This file is autogenerated from the output of
 
140
..     %(brzcmd)s help topics
 
141
..     %(brzcmd)s help commands
 
142
..     %(brzcmd)s help <cmd>
 
143
..
 
144
 
 
145
"""
 
146
 
 
147
 
 
148
rstx_head = """\
 
149
#####################
 
150
Breezy User Reference
 
151
#####################
 
152
 
 
153
About This Manual
 
154
#################
 
155
 
 
156
This manual is generated from Breezy's online help. To use
 
157
the online help system, try the following commands.
 
158
 
 
159
    Introduction including a list of commonly used commands::
 
160
 
 
161
        brz help
 
162
 
 
163
    List of topics and a summary of each::
 
164
 
 
165
        brz help topics
 
166
 
 
167
    List of commands and a summary of each::
 
168
 
 
169
        brz help commands
 
170
 
 
171
    More information about a particular topic or command::
 
172
 
 
173
        brz help topic-or-command-name
 
174
 
 
175
The following web sites provide further information on Breezy:
 
176
 
 
177
:Home page:                     http://www.breezy-vcs.org/
 
178
:Breezy docs:                   http://www.breezy-vcs.org/doc/
 
179
:Launchpad:                     https://launchpad.net/brz/
 
180
"""
 
181
 
 
182
 
 
183
rstx_foot = """
 
184
"""