Document fdpexpect module

3 files changed, 26 insertions, 3 deletions

diff --git a/doc/api/fdpexpect.rst b/doc/api/fdpexpect.rst
new file mode 100644
index 0000000..3931616
--- /dev/null
+++ b/doc/api/fdpexpect.rst
@@ -0,0 +1,22 @@
+fdpexpect module
+================
+
+.. automodule:: pexpect.fdpexpect
+
+fdspawn class
+-------------
+
+.. autoclass:: fdspawn
+   :show-inheritance:
+
+   .. automethod:: __init__
+   .. automethod:: isalive
+   .. automethod:: close
+
+   .. note::
+      :class:`fdspawn` inherits all of the methods of :class:`~pexpect.spawn`, 
+      but not all of them can be used, especially if the file descriptor is not
+      a terminal. Some methods may do nothing (e.g. :meth:`~fdspawn.kill`), while
+      others will raise an exception (e.g. :meth:`~fdspawn.terminate`).
+      This behaviour might be made more consistent in the future, so try to
+      avoid relying on it.
\ No newline at end of file
diff --git a/doc/api/index.rst b/doc/api/index.rst
index a18bae0..29303fd 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -4,4 +4,5 @@ API documentation
 .. toctree::
    :maxdepth: 2
 
-   pexpect
\ No newline at end of file
+   pexpect
+   fdpexpect
\ No newline at end of file
diff --git a/doc/api/pexpect.rst b/doc/api/pexpect.rst
index bc24003..4c60f9c 100644
--- a/doc/api/pexpect.rst
+++ b/doc/api/pexpect.rst
@@ -3,8 +3,8 @@ pexpect module
 
 .. automodule:: pexpect
 
-spawn object
-------------
+spawn class
+-----------
 
 .. autoclass:: spawn