terminator/doc/apidoc/terminatorlib.rst
Stephen Boddy 1d977cc6aa 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
2015-08-08 04:11:30 +02:00

239 lines
4.5 KiB
ReStructuredText

terminatorlib package
=====================
Subpackages
-----------
.. toctree::
terminatorlib.configobj
terminatorlib.plugins
Submodules
----------
terminatorlib.borg module
-------------------------
.. automodule:: terminatorlib.borg
:members:
:undoc-members:
:show-inheritance:
terminatorlib.config module
---------------------------
.. automodule:: terminatorlib.config
:members:
:undoc-members:
:show-inheritance:
terminatorlib.container module
------------------------------
.. automodule:: terminatorlib.container
:members:
:undoc-members:
:show-inheritance:
terminatorlib.cwd module
------------------------
.. automodule:: terminatorlib.cwd
:members:
:undoc-members:
:show-inheritance:
terminatorlib.debugserver module
--------------------------------
.. automodule:: terminatorlib.debugserver
:members:
:undoc-members:
:show-inheritance:
terminatorlib.editablelabel module
----------------------------------
.. automodule:: terminatorlib.editablelabel
:members:
:undoc-members:
:show-inheritance:
terminatorlib.encoding module
-----------------------------
.. automodule:: terminatorlib.encoding
:members:
:undoc-members:
:show-inheritance:
terminatorlib.factory module
----------------------------
.. automodule:: terminatorlib.factory
:members:
:undoc-members:
:show-inheritance:
terminatorlib.freebsd module
----------------------------
.. automodule:: terminatorlib.freebsd
:members:
:undoc-members:
:show-inheritance:
terminatorlib.ipc module
------------------------
.. automodule:: terminatorlib.ipc
:members:
:undoc-members:
:show-inheritance:
terminatorlib.keybindings module
--------------------------------
.. automodule:: terminatorlib.keybindings
:members:
:undoc-members:
:show-inheritance:
terminatorlib.layoutlauncher module
-----------------------------------
.. automodule:: terminatorlib.layoutlauncher
:members:
:undoc-members:
:show-inheritance:
terminatorlib.notebook module
-----------------------------
.. automodule:: terminatorlib.notebook
:members:
:undoc-members:
:show-inheritance:
terminatorlib.optionparse module
--------------------------------
.. automodule:: terminatorlib.optionparse
:members:
:undoc-members:
:show-inheritance:
terminatorlib.paned module
--------------------------
.. automodule:: terminatorlib.paned
:members:
:undoc-members:
:show-inheritance:
terminatorlib.plugin module
---------------------------
.. automodule:: terminatorlib.plugin
:members:
:undoc-members:
:show-inheritance:
terminatorlib.prefseditor module
--------------------------------
.. automodule:: terminatorlib.prefseditor
:members:
:undoc-members:
:show-inheritance:
terminatorlib.searchbar module
------------------------------
.. automodule:: terminatorlib.searchbar
:members:
:undoc-members:
:show-inheritance:
terminatorlib.signalman module
------------------------------
.. automodule:: terminatorlib.signalman
:members:
:undoc-members:
:show-inheritance:
terminatorlib.terminal module
-----------------------------
.. automodule:: terminatorlib.terminal
:members:
:undoc-members:
:show-inheritance:
terminatorlib.terminal_popup_menu module
----------------------------------------
.. automodule:: terminatorlib.terminal_popup_menu
:members:
:undoc-members:
:show-inheritance:
terminatorlib.terminator module
-------------------------------
.. automodule:: terminatorlib.terminator
:members:
:undoc-members:
:show-inheritance:
terminatorlib.titlebar module
-----------------------------
.. automodule:: terminatorlib.titlebar
:members:
:undoc-members:
:show-inheritance:
terminatorlib.translation module
--------------------------------
.. automodule:: terminatorlib.translation
:members:
:undoc-members:
:show-inheritance:
terminatorlib.util module
-------------------------
.. automodule:: terminatorlib.util
:members:
:undoc-members:
:show-inheritance:
terminatorlib.version module
----------------------------
.. automodule:: terminatorlib.version
:members:
:undoc-members:
:show-inheritance:
terminatorlib.window module
---------------------------
.. automodule:: terminatorlib.window
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: terminatorlib
:members:
:undoc-members:
:show-inheritance: