← Back to branch summary

~stephen-j-boddy/terminator/bugfix-1318542-double-chars

« back to all changes in this revision

Viewing changes to doc/apidoc/_build/html/_modules/index.html

  • Committer: Stephen Boddy
  • Date: 2015-08-08 02:11:30 UTC
  • Revision ID: stephen.j.boddy@gmail.com-20150808021130-9c1npu4gvenkcb1p
A manual has been added to Terminator
* Added source and generated html of manual, and API doc
* setup.py can install the manual (and by extension do can debuild)
* setup.py has (inactive) code for generating the html from the source
  but this will break if rtd theme is not available
* A few changes to doc strings to make the autodoc prettier
* Added help shortcut, by default F1 to open the local manual
* Added button to About tab to launch manual
* A couple of additional string to translate related to manual/help

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/apidoc/_build/html/_modules/index.html
 
1
 
 
2
 
 
3
<!DOCTYPE html>
 
4
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
 
5
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
 
6
<head>
 
7
  <meta charset="utf-8">
 
8
  
 
9
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
10
  
 
11
  <title>Overview: module code &mdash; terminatorlib 0.98 documentation</title>
 
12
  
 
13
 
 
14
  
 
15
  
 
16
 
 
17
  
 
18
 
 
19
  
 
20
  
 
21
    
 
22
 
 
23
  
 
24
 
 
25
  
 
26
  
 
27
    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
 
28
  
 
29
 
 
30
  
 
31
 
 
32
  
 
33
    <link rel="top" title="terminatorlib 0.98 documentation" href="../index.html"/> 
 
34
 
 
35
  
 
36
  <script src="_static/js/modernizr.min.js"></script>
 
37
 
 
38
</head>
 
39
 
 
40
<body class="wy-body-for-nav" role="document">
 
41
 
 
42
  <div class="wy-grid-for-nav">
 
43
 
 
44
    
 
45
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
 
46
      <div class="wy-side-nav-search">
 
47
        
 
48
 
 
49
        
 
50
          <a href="../index.html" class="icon icon-home"> terminatorlib
 
51
        
 
52
 
 
53
        
 
54
        </a>
 
55
 
 
56
        
 
57
<div role="search">
 
58
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
 
59
    <input type="text" name="q" placeholder="Search docs" />
 
60
    <input type="hidden" name="check_keywords" value="yes" />
 
61
    <input type="hidden" name="area" value="default" />
 
62
  </form>
 
63
</div>
 
64
 
 
65
        
 
66
      </div>
 
67
 
 
68
      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 
69
        
 
70
          
 
71
          
 
72
              <ul>
 
73
<li class="toctree-l1"><a class="reference internal" href="../terminatorlib.html">terminatorlib package</a><ul>
 
74
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#subpackages">Subpackages</a><ul>
 
75
<li class="toctree-l3"><a class="reference internal" href="../terminatorlib.configobj.html">terminatorlib.configobj package</a><ul>
 
76
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.configobj.html#submodules">Submodules</a></li>
 
77
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.configobj.html#module-terminatorlib.configobj.configobj">terminatorlib.configobj.configobj module</a></li>
 
78
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.configobj.html#module-terminatorlib.configobj.validate">terminatorlib.configobj.validate module</a></li>
 
79
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.configobj.html#module-terminatorlib.configobj">Module contents</a></li>
 
80
</ul>
 
81
</li>
 
82
<li class="toctree-l3"><a class="reference internal" href="../terminatorlib.plugins.html">terminatorlib.plugins package</a><ul>
 
83
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#submodules">Submodules</a></li>
 
84
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.activitywatch">terminatorlib.plugins.activitywatch module</a></li>
 
85
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.custom_commands">terminatorlib.plugins.custom_commands module</a></li>
 
86
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.logger">terminatorlib.plugins.logger module</a></li>
 
87
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.maven">terminatorlib.plugins.maven module</a></li>
 
88
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.terminalshot">terminatorlib.plugins.terminalshot module</a></li>
 
89
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.testplugin">terminatorlib.plugins.testplugin module</a></li>
 
90
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins.url_handlers">terminatorlib.plugins.url_handlers module</a></li>
 
91
<li class="toctree-l4"><a class="reference internal" href="../terminatorlib.plugins.html#module-terminatorlib.plugins">Module contents</a></li>
 
92
</ul>
 
93
</li>
 
94
</ul>
 
95
</li>
 
96
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#submodules">Submodules</a></li>
 
97
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.borg">terminatorlib.borg module</a></li>
 
98
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.config">terminatorlib.config module</a></li>
 
99
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.container">terminatorlib.container module</a></li>
 
100
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.cwd">terminatorlib.cwd module</a></li>
 
101
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.debugserver">terminatorlib.debugserver module</a></li>
 
102
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.editablelabel">terminatorlib.editablelabel module</a></li>
 
103
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.encoding">terminatorlib.encoding module</a></li>
 
104
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.factory">terminatorlib.factory module</a></li>
 
105
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.freebsd">terminatorlib.freebsd module</a></li>
 
106
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.ipc">terminatorlib.ipc module</a></li>
 
107
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.keybindings">terminatorlib.keybindings module</a></li>
 
108
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.layoutlauncher">terminatorlib.layoutlauncher module</a></li>
 
109
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.notebook">terminatorlib.notebook module</a></li>
 
110
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.optionparse">terminatorlib.optionparse module</a></li>
 
111
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.paned">terminatorlib.paned module</a></li>
 
112
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.plugin">terminatorlib.plugin module</a></li>
 
113
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.prefseditor">terminatorlib.prefseditor module</a></li>
 
114
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.searchbar">terminatorlib.searchbar module</a></li>
 
115
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.signalman">terminatorlib.signalman module</a></li>
 
116
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.terminal">terminatorlib.terminal module</a></li>
 
117
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.terminal_popup_menu">terminatorlib.terminal_popup_menu module</a></li>
 
118
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.terminator">terminatorlib.terminator module</a></li>
 
119
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.titlebar">terminatorlib.titlebar module</a></li>
 
120
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.translation">terminatorlib.translation module</a></li>
 
121
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.util">terminatorlib.util module</a></li>
 
122
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.version">terminatorlib.version module</a></li>
 
123
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib.window">terminatorlib.window module</a></li>
 
124
<li class="toctree-l2"><a class="reference internal" href="../terminatorlib.html#module-terminatorlib">Module contents</a></li>
 
125
</ul>
 
126
</li>
 
127
</ul>
 
128
 
 
129
          
 
130
        
 
131
      </div>
 
132
      &nbsp;
 
133
    </nav>
 
134
 
 
135
    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 
136
 
 
137
      
 
138
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
 
139
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
140
        <a href="../index.html">terminatorlib</a>
 
141
      </nav>
 
142
 
 
143
 
 
144
      
 
145
      <div class="wy-nav-content">
 
146
        <div class="rst-content">
 
147
          <div role="navigation" aria-label="breadcrumbs navigation">
 
148
  <ul class="wy-breadcrumbs">
 
149
    <li><a href="../index.html">Docs</a> &raquo;</li>
 
150
      
 
151
    <li>Overview: module code</li>
 
152
      <li class="wy-breadcrumbs-aside">
 
153
        
 
154
          
 
155
        
 
156
      </li>
 
157
  </ul>
 
158
  <hr/>
 
159
</div>
 
160
          <div role="main" class="document">
 
161
            
 
162
  <h1>All modules for which code is available</h1>
 
163
<ul><li><a href="gtk/_gtk.html">gtk._gtk</a></li>
 
164
<li><a href="terminatorlib/borg.html">terminatorlib.borg</a></li>
 
165
<li><a href="terminatorlib/config.html">terminatorlib.config</a></li>
 
166
<li><a href="terminatorlib/configobj/configobj.html">terminatorlib.configobj.configobj</a></li>
 
167
<li><a href="terminatorlib/configobj/validate.html">terminatorlib.configobj.validate</a></li>
 
168
<li><a href="terminatorlib/container.html">terminatorlib.container</a></li>
 
169
<li><a href="terminatorlib/cwd.html">terminatorlib.cwd</a></li>
 
170
<li><a href="terminatorlib/debugserver.html">terminatorlib.debugserver</a></li>
 
171
<li><a href="terminatorlib/editablelabel.html">terminatorlib.editablelabel</a></li>
 
172
<li><a href="terminatorlib/encoding.html">terminatorlib.encoding</a></li>
 
173
<li><a href="terminatorlib/factory.html">terminatorlib.factory</a></li>
 
174
<li><a href="terminatorlib/freebsd.html">terminatorlib.freebsd</a></li>
 
175
<li><a href="terminatorlib/ipc.html">terminatorlib.ipc</a></li>
 
176
<li><a href="terminatorlib/keybindings.html">terminatorlib.keybindings</a></li>
 
177
<li><a href="terminatorlib/layoutlauncher.html">terminatorlib.layoutlauncher</a></li>
 
178
<li><a href="terminatorlib/notebook.html">terminatorlib.notebook</a></li>
 
179
<li><a href="terminatorlib/optionparse.html">terminatorlib.optionparse</a></li>
 
180
<li><a href="terminatorlib/paned.html">terminatorlib.paned</a></li>
 
181
<li><a href="terminatorlib/plugin.html">terminatorlib.plugin</a></li>
 
182
<li><a href="terminatorlib/plugins/activitywatch.html">terminatorlib.plugins.activitywatch</a></li>
 
183
<li><a href="terminatorlib/plugins/custom_commands.html">terminatorlib.plugins.custom_commands</a></li>
 
184
<li><a href="terminatorlib/plugins/logger.html">terminatorlib.plugins.logger</a></li>
 
185
<li><a href="terminatorlib/plugins/maven.html">terminatorlib.plugins.maven</a></li>
 
186
<li><a href="terminatorlib/plugins/terminalshot.html">terminatorlib.plugins.terminalshot</a></li>
 
187
<li><a href="terminatorlib/plugins/testplugin.html">terminatorlib.plugins.testplugin</a></li>
 
188
<li><a href="terminatorlib/plugins/url_handlers.html">terminatorlib.plugins.url_handlers</a></li>
 
189
<li><a href="terminatorlib/prefseditor.html">terminatorlib.prefseditor</a></li>
 
190
<li><a href="terminatorlib/searchbar.html">terminatorlib.searchbar</a></li>
 
191
<li><a href="terminatorlib/signalman.html">terminatorlib.signalman</a></li>
 
192
<li><a href="terminatorlib/terminal.html">terminatorlib.terminal</a></li>
 
193
<li><a href="terminatorlib/terminal_popup_menu.html">terminatorlib.terminal_popup_menu</a></li>
 
194
<li><a href="terminatorlib/terminator.html">terminatorlib.terminator</a></li>
 
195
<li><a href="terminatorlib/titlebar.html">terminatorlib.titlebar</a></li>
 
196
<li><a href="terminatorlib/util.html">terminatorlib.util</a></li>
 
197
<li><a href="terminatorlib/window.html">terminatorlib.window</a></li>
 
198
</ul>
 
199
 
 
200
          </div>
 
201
          <footer>
 
202
  
 
203
 
 
204
  <hr/>
 
205
 
 
206
  <div role="contentinfo">
 
207
    <p>
 
208
        &copy; Copyright 2015, Stephen Boddy, licensed under the CC-BY-SA..
 
209
    </p>
 
210
  </div>
 
211
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
 
212
 
 
213
</footer>
 
214
 
 
215
        </div>
 
216
      </div>
 
217
 
 
218
    </section>
 
219
 
 
220
  </div>
 
221
  
 
222
 
 
223
 
 
224
  
 
225
 
 
226
    <script type="text/javascript">
 
227
        var DOCUMENTATION_OPTIONS = {
 
228
            URL_ROOT:'../',
 
229
            VERSION:'0.98',
 
230
            COLLAPSE_INDEX:false,
 
231
            FILE_SUFFIX:'.html',
 
232
            HAS_SOURCE:  true
 
233
        };
 
234
    </script>
 
235
      <script type="text/javascript" src="../_static/jquery.js"></script>
 
236
      <script type="text/javascript" src="../_static/underscore.js"></script>
 
237
      <script type="text/javascript" src="../_static/doctools.js"></script>
 
238
 
 
239
  
 
240
 
 
241
  
 
242
  
 
243
    <script type="text/javascript" src="../_static/js/theme.js"></script>
 
244
  
 
245
 
 
246
  
 
247
  
 
248
  <script type="text/javascript">
 
249
      jQuery(function () {
 
250
          SphinxRtdTheme.StickyNav.enable();
 
251
      });
 
252
  </script>
 
253
   
 
254
 
 
255
</body>
 
256
</html>
 
 
b'\\ No newline at end of file'