← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/apidoc/terminatorlib.rst

  • 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/terminatorlib.rst
 
1
terminatorlib package
 
2
=====================
 
3
 
 
4
Subpackages
 
5
-----------
 
6
 
 
7
.. toctree::
 
8
 
 
9
    terminatorlib.configobj
 
10
    terminatorlib.plugins
 
11
 
 
12
Submodules
 
13
----------
 
14
 
 
15
terminatorlib.borg module
 
16
-------------------------
 
17
 
 
18
.. automodule:: terminatorlib.borg
 
19
    :members:
 
20
    :undoc-members:
 
21
    :show-inheritance:
 
22
 
 
23
terminatorlib.config module
 
24
---------------------------
 
25
 
 
26
.. automodule:: terminatorlib.config
 
27
    :members:
 
28
    :undoc-members:
 
29
    :show-inheritance:
 
30
 
 
31
terminatorlib.container module
 
32
------------------------------
 
33
 
 
34
.. automodule:: terminatorlib.container
 
35
    :members:
 
36
    :undoc-members:
 
37
    :show-inheritance:
 
38
 
 
39
terminatorlib.cwd module
 
40
------------------------
 
41
 
 
42
.. automodule:: terminatorlib.cwd
 
43
    :members:
 
44
    :undoc-members:
 
45
    :show-inheritance:
 
46
 
 
47
terminatorlib.debugserver module
 
48
--------------------------------
 
49
 
 
50
.. automodule:: terminatorlib.debugserver
 
51
    :members:
 
52
    :undoc-members:
 
53
    :show-inheritance:
 
54
 
 
55
terminatorlib.editablelabel module
 
56
----------------------------------
 
57
 
 
58
.. automodule:: terminatorlib.editablelabel
 
59
    :members:
 
60
    :undoc-members:
 
61
    :show-inheritance:
 
62
 
 
63
terminatorlib.encoding module
 
64
-----------------------------
 
65
 
 
66
.. automodule:: terminatorlib.encoding
 
67
    :members:
 
68
    :undoc-members:
 
69
    :show-inheritance:
 
70
 
 
71
terminatorlib.factory module
 
72
----------------------------
 
73
 
 
74
.. automodule:: terminatorlib.factory
 
75
    :members:
 
76
    :undoc-members:
 
77
    :show-inheritance:
 
78
 
 
79
terminatorlib.freebsd module
 
80
----------------------------
 
81
 
 
82
.. automodule:: terminatorlib.freebsd
 
83
    :members:
 
84
    :undoc-members:
 
85
    :show-inheritance:
 
86
 
 
87
terminatorlib.ipc module
 
88
------------------------
 
89
 
 
90
.. automodule:: terminatorlib.ipc
 
91
    :members:
 
92
    :undoc-members:
 
93
    :show-inheritance:
 
94
 
 
95
terminatorlib.keybindings module
 
96
--------------------------------
 
97
 
 
98
.. automodule:: terminatorlib.keybindings
 
99
    :members:
 
100
    :undoc-members:
 
101
    :show-inheritance:
 
102
 
 
103
terminatorlib.layoutlauncher module
 
104
-----------------------------------
 
105
 
 
106
.. automodule:: terminatorlib.layoutlauncher
 
107
    :members:
 
108
    :undoc-members:
 
109
    :show-inheritance:
 
110
 
 
111
terminatorlib.notebook module
 
112
-----------------------------
 
113
 
 
114
.. automodule:: terminatorlib.notebook
 
115
    :members:
 
116
    :undoc-members:
 
117
    :show-inheritance:
 
118
 
 
119
terminatorlib.optionparse module
 
120
--------------------------------
 
121
 
 
122
.. automodule:: terminatorlib.optionparse
 
123
    :members:
 
124
    :undoc-members:
 
125
    :show-inheritance:
 
126
 
 
127
terminatorlib.paned module
 
128
--------------------------
 
129
 
 
130
.. automodule:: terminatorlib.paned
 
131
    :members:
 
132
    :undoc-members:
 
133
    :show-inheritance:
 
134
 
 
135
terminatorlib.plugin module
 
136
---------------------------
 
137
 
 
138
.. automodule:: terminatorlib.plugin
 
139
    :members:
 
140
    :undoc-members:
 
141
    :show-inheritance:
 
142
 
 
143
terminatorlib.prefseditor module
 
144
--------------------------------
 
145
 
 
146
.. automodule:: terminatorlib.prefseditor
 
147
    :members:
 
148
    :undoc-members:
 
149
    :show-inheritance:
 
150
 
 
151
terminatorlib.searchbar module
 
152
------------------------------
 
153
 
 
154
.. automodule:: terminatorlib.searchbar
 
155
    :members:
 
156
    :undoc-members:
 
157
    :show-inheritance:
 
158
 
 
159
terminatorlib.signalman module
 
160
------------------------------
 
161
 
 
162
.. automodule:: terminatorlib.signalman
 
163
    :members:
 
164
    :undoc-members:
 
165
    :show-inheritance:
 
166
 
 
167
terminatorlib.terminal module
 
168
-----------------------------
 
169
 
 
170
.. automodule:: terminatorlib.terminal
 
171
    :members:
 
172
    :undoc-members:
 
173
    :show-inheritance:
 
174
 
 
175
terminatorlib.terminal_popup_menu module
 
176
----------------------------------------
 
177
 
 
178
.. automodule:: terminatorlib.terminal_popup_menu
 
179
    :members:
 
180
    :undoc-members:
 
181
    :show-inheritance:
 
182
 
 
183
terminatorlib.terminator module
 
184
-------------------------------
 
185
 
 
186
.. automodule:: terminatorlib.terminator
 
187
    :members:
 
188
    :undoc-members:
 
189
    :show-inheritance:
 
190
 
 
191
terminatorlib.titlebar module
 
192
-----------------------------
 
193
 
 
194
.. automodule:: terminatorlib.titlebar
 
195
    :members:
 
196
    :undoc-members:
 
197
    :show-inheritance:
 
198
 
 
199
terminatorlib.translation module
 
200
--------------------------------
 
201
 
 
202
.. automodule:: terminatorlib.translation
 
203
    :members:
 
204
    :undoc-members:
 
205
    :show-inheritance:
 
206
 
 
207
terminatorlib.util module
 
208
-------------------------
 
209
 
 
210
.. automodule:: terminatorlib.util
 
211
    :members:
 
212
    :undoc-members:
 
213
    :show-inheritance:
 
214
 
 
215
terminatorlib.version module
 
216
----------------------------
 
217
 
 
218
.. automodule:: terminatorlib.version
 
219
    :members:
 
220
    :undoc-members:
 
221
    :show-inheritance:
 
222
 
 
223
terminatorlib.window module
 
224
---------------------------
 
225
 
 
226
.. automodule:: terminatorlib.window
 
227
    :members:
 
228
    :undoc-members:
 
229
    :show-inheritance:
 
230
 
 
231
 
 
232
Module contents
 
233
---------------
 
234
 
 
235
.. automodule:: terminatorlib
 
236
    :members:
 
237
    :undoc-members:
 
238
    :show-inheritance: