summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorErik Rose <erik@mozilla.com>2011-11-18 17:34:29 -0800
committerErik Rose <erik@mozilla.com>2011-11-18 17:34:29 -0800
commit5963fd875707193349af6b77ec9dff280b46811f (patch)
tree88e4887a26f8860b280004d91152c385c9d1f05f /docs/index.rst
parent6c84202286e55eb3e4e86541a61fef668f091689 (diff)
downloadblessings-5963fd875707193349af6b77ec9dff280b46811f.tar.gz
Bootstrap Sphinx docs.
* Clean up docstrings' Sphinx formatting. * Put a version SPOT in __init__.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..02d07d6
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+=======================
+Blessings API Reference
+=======================
+
+Read The Readme First
+=====================
+
+This is the API documentation for the Blessings terminal library. Because
+Blessings uses quite a bit of dynamism, you should `read the readme first`_, as
+not all the useful stuff shows up in these autogenerated docs. However, if
+you're looking for seldom-used keyword args or a peek at the internals, you're
+in the right place.
+
+.. _`read the readme first`: http://pypi.python.org/pypi/blessings/
+
+Then Read This If You Want
+==========================
+
+.. autoclass:: blessings.Terminal
+ :members: __init__, __getattr__, location, height, width