← 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.configobj.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.configobj.rst
 
1
terminatorlib.configobj package
 
2
===============================
 
3
 
 
4
Submodules
 
5
----------
 
6
 
 
7
terminatorlib.configobj.configobj module
 
8
----------------------------------------
 
9
 
 
10
.. automodule:: terminatorlib.configobj.configobj
 
11
    :members:
 
12
    :undoc-members:
 
13
    :show-inheritance:
 
14
 
 
15
terminatorlib.configobj.validate module
 
16
---------------------------------------
 
17
 
 
18
.. automodule:: terminatorlib.configobj.validate
 
19
    :members:
 
20
    :undoc-members:
 
21
    :show-inheritance:
 
22
 
 
23
 
 
24
Module contents
 
25
---------------
 
26
 
 
27
.. automodule:: terminatorlib.configobj
 
28
    :members:
 
29
    :undoc-members:
 
30
    :show-inheritance: