summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorThomas Kluyver <takowl@gmail.com>2013-09-25 15:44:36 -0700
committerThomas Kluyver <takowl@gmail.com>2013-09-25 15:44:36 -0700
commitf7832fe55f3406148bc9f22ea133ff0032db7f91 (patch)
tree8d333fdfac8853f14fd5eebfda68f56822a5062e /doc/api
parent137f605dd0f25511e83e1bfb455676e2498fe7a2 (diff)
downloadpexpect-f7832fe55f3406148bc9f22ea133ff0032db7f91.tar.gz
Document screen and ANSI
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/ANSI.rst14
-rw-r--r--doc/api/fdpexpect.rst4
-rw-r--r--doc/api/index.rst4
-rw-r--r--doc/api/pexpect.rst4
-rw-r--r--doc/api/pxssh.rst4
-rw-r--r--doc/api/screen.rst10
6 files changed, 33 insertions, 7 deletions
diff --git a/doc/api/ANSI.rst b/doc/api/ANSI.rst
new file mode 100644
index 0000000..064563d
--- /dev/null
+++ b/doc/api/ANSI.rst
@@ -0,0 +1,14 @@
+ANSI - ANSI (VT100) terminal emulator
+=====================================
+
+.. automodule:: pexpect.ANSI
+
+.. autoclass:: term
+ :show-inheritance:
+
+.. autoclass:: ANSI
+ :show-inheritance:
+
+ .. automethod:: write_ch
+ .. automethod:: write
+ .. automethod:: process \ No newline at end of file
diff --git a/doc/api/fdpexpect.rst b/doc/api/fdpexpect.rst
index 3931616..8321454 100644
--- a/doc/api/fdpexpect.rst
+++ b/doc/api/fdpexpect.rst
@@ -1,5 +1,5 @@
-fdpexpect module
-================
+fdpexpect - use pexpect with a file descriptor
+==============================================
.. automodule:: pexpect.fdpexpect
diff --git a/doc/api/index.rst b/doc/api/index.rst
index 3b245d1..b902131 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -6,4 +6,6 @@ API documentation
pexpect
fdpexpect
- pxssh \ No newline at end of file
+ pxssh
+ screen
+ ANSI \ No newline at end of file
diff --git a/doc/api/pexpect.rst b/doc/api/pexpect.rst
index 4c60f9c..a6d1374 100644
--- a/doc/api/pexpect.rst
+++ b/doc/api/pexpect.rst
@@ -1,5 +1,5 @@
-pexpect module
-==============
+Core pexpect components
+=======================
.. automodule:: pexpect
diff --git a/doc/api/pxssh.rst b/doc/api/pxssh.rst
index 91b7fe0..c3388f0 100644
--- a/doc/api/pxssh.rst
+++ b/doc/api/pxssh.rst
@@ -1,5 +1,5 @@
-pxssh module
-============
+pxssh - control an SSH session
+==============================
.. automodule:: pexpect.pxssh
diff --git a/doc/api/screen.rst b/doc/api/screen.rst
new file mode 100644
index 0000000..8268fb9
--- /dev/null
+++ b/doc/api/screen.rst
@@ -0,0 +1,10 @@
+screen - manage a virtual 'screen'
+==================================
+
+.. automodule:: pexpect.screen
+
+.. autoclass:: screen
+ :members:
+
+ .. automethod:: __init__
+ .. automethod:: __str__ \ No newline at end of file