Permalink
Browse files

Updated documentation

  - No more *.rst suffixes
  - README is used as a base for Sphinx-powered documentation
  • Loading branch information...
1 parent 9e0f0eb commit 1badb23f4c12f3143038436a2cad98be6ed363fb @superbobry superbobry committed Jun 27, 2011
Showing with 23 additions and 87 deletions.
  1. 0 AUTHORS.rst → AUTHORS
  2. +18 −4 README.rst → README
  3. +4 −82 docs/index.rst
  4. +1 −1 setup.py
File renamed without changes.
View
@@ -1,3 +1,5 @@
+.. -*- mode: rst -*-
+
::
_
@@ -12,8 +14,8 @@
-- chicks dig dudes with terminals (c) @samfoo
-About
------
+What is ``pyte``?
+-----------------
What is ``pyte``? It's an in memory VTXXX-compatible terminal emulator.
*XXX* stands for a series video terminals, developed by
@@ -43,8 +45,20 @@ you can use ``easy_install -U pyte``. Otherwise, you can download the source
from `GitHub <http://github.com/selectel/pyte>`_ and run ``python setup.py install``.
-Example
--------
+Quick example
+-------------
+
+There are two important classes in ``pyte``:
+:class:`~pyte.screens.Screen` and :class:`~pyte.streams.Stream`. The
+``Screen`` is the terminal screen emulator. It maintains an in-memory
+buffer of text and text-attributes to display on screen. The ``Stream``
+is the stream processor. It manages the state of the input and dispatches
+events to anything that's listening about things that are going on.
+Events are things like ``LINEFEED``, ``DRAW "a"``, or ``CURSOR_POSITION 10 10``.
+See the :ref:`API <api>` for more details.
+
+In general, if you just want to know what's being displayed on screen you
+can do something like the following:
>>> import pyte
>>> screen = pyte.Screen(80, 24)
View
@@ -3,90 +3,12 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-::
+.. include:: ../README
- _
- | |
- _ __ _ _ | |_ ___
- | '_ \ | | | || __|/ _ \
- | |_) || |_| || |_| __/
- | .__/ \__, | \__|\___|
- | | __/ |
- |_| |___/ 0.4.2
- -- chicks dig dudes with terminals (c) @samfoo
-
-What is ``pyte``?
------------------
-
-What is ``pyte``? It's an in memory VTXXX-compatible terminal emulator.
-*XXX* stands for a series video terminals, developed by
-`DEC <http://en.wikipedia.org/wiki/Digital_Equipment_Corporation>`_ between
-1970 and 1995. The first, and probably the most famous one, was VT100
-terminal, which is now a de-facto standard for all virtual terminal
-emulators. ``pyte`` follows the suit.
-
-So, why would one need a terminal emulator library?
-
-* To screen scrape terminal apps, for example ``htop`` or ``aptitude``.
-* To write cross platform terminal emulators; either with a graphical
- (`xterm <http://invisible-island.net/xterm/>`_,
- `rxvt <http://www.rxvt.org/>`_) or a web interface, like
- `AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`_.
-* To have fun, hacking on the ancient, poorly documented technologies.
-
-**Note**: ``pyte`` started as a fork of `vt102 <http://github.com/samfoo/vt102>`_,
-which is an incomplete implementation of VT100 features.
-
-
-Quick example
--------------
-
-There are two important classes in ``pyte``:
-:class:`~pyte.screens.Screen` and :class:`~pyte.streams.Stream`. The
-``Screen`` is the terminal screen emulator. It maintains an in-memory
-buffer of text and text-attributes to display on screen. The ``Stream``
-is the stream processor. It manages the state of the input and dispatches
-events to anything that's listening about things that are going on.
-Events are things like ``LINEFEED``, ``DRAW "a"``, or ``CURSOR_POSITION 10 10``.
-See the :ref:`API <api>` for more details.
-
-In general, if you just want to know what's being displayed on screen you
-can do something like the following:
-
- >>> import pyte
- >>> screen = pyte.Screen(80, 24)
- >>> stream = pyte.Stream()
- >>> stream.attach(screen)
- >>> stream.feed("Hello World!")
- >>> screen.display
- ['Hello World! ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ',
- ' ']
-
-Want more?
------------
+More ...
+--------
Unfortunately, ``pyte`` doesn't have anything but the :ref:`API documentation <api>`
at the moment.
+
View
@@ -16,7 +16,7 @@
DESCRIPTION = "Simple VTXXX-compatible terminal emulator."
try:
- LONG_DESCRIPTION = open(os.path.join(here, "README.rst")).read()
+ LONG_DESCRIPTION = open(os.path.join(here, "README")).read()
except IOError:
LONG_DESCRIPTION = ""

0 comments on commit 1badb23

Please sign in to comment.