thirdparty/pyqtermwidget/doc/index.rst

   1 .. PyQTermWidget documentation master file, created by
   2    sphinx-quickstart on Wed Oct 12 09:49:10 2011.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Welcome to PyQTermWidget's documentation!
   7 =========================================
   8
   9 Unlike the older pyqonsole this console widget works with PyQt4 and let's you
  10 embed a shell into your application.
  11
  12 The vt100 terminal emulation code is based on AjaxTerm and WebShell.
  13 All code is distributed under the General Public License 2.
  14
  15
  16 Contents:
  17
  18 .. toctree::
  19    :maxdepth: 2
  20
  21    usage
  22    todo
  23
  24
  25 How to get it
  26 -------------
  27
  28 The latest snapshot is available at::
  29
  30   https://bitbucket.org/henning/pyqtermwidget/get/tip.tar.bz2
  31
  32
  33 To clone the Mercurial repository do::
  34
  35   hg clone https://bitbucket.org/henning/pyqtermwidget
  36
  37 Or just got to the BitBucket overview page: https://bitbucket.org/henning/pyqtermwidget
  38
  39
  40
  41 .. image:: screenshot1.png
  42
  43
  44 The Python Packaging Index (PyPI) also contains releases:  http://pypi.python.org/pypi/pyqterm
  45
  46 The generated HTML-documentation is hosted at http://pyqtermwidget.rtfd.org/
  47 (PDF: http://media.readthedocs.org/pdf/pyqtermwidget/latest/pyqtermwidget.pdf).
  48
  49
  50 Indices and tables
  51 ==================
  52
  53 * :ref:`genindex`
  54 * :ref:`modindex`
  55 * :ref:`search`
  56