Start writing docs

pexpect · Oct 13, 2014 · e337538 · e337538
1 parent 8c3e7c3
commit e337538
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ __pycache__
 /build/
 /dist/
 MANIFEST
+docs/_build/
diff --git a/README.rst b/README.rst
@@ -1,4 +1,5 @@
-Launch and control a process in a pseudo terminal
+Launch a subprocess in a pseudo terminal (pty), and interact with both the
+process and its pty.
 
 Sometimes, piping stdin and stdout is not enough. There might be a password
 prompt that doesn't read from stdin, output that changes when it's going to a

diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,10 @@
+Ptyprocess API
+==============
+
+.. module:: ptyprocess
+
+.. autoclass:: PtyProcess
+
+   .. automethod:: spawn
+
+.. autoclass:: PtyProcessUnicode
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,17 +1,14 @@
-.. Ptyprocess documentation master file, created by
-   sphinx-quickstart on Mon Oct 13 11:03:02 2014.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Ptyprocess
+==========
 
-Welcome to Ptyprocess's documentation!
-======================================
+.. include:: ../README.rst
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
+   api
 
 Indices and tables
 ==================