sphinx: Document bpdb.

sebastinas · sebastinas · commit 349a1e7b94ce · 2012-07-16T13:06:46.000+02:00
Thanks to anonymous for the text. Closes: bpython#169
diff --git a/doc/sphinx/source/bpaste.rst b/doc/sphinx/source/bpaste.rst
@@ -1,4 +1,4 @@
-.. _authors:
+.. _bpaste:
 
 bpaste
 ======
diff --git a/doc/sphinx/source/bpdb.rst b/doc/sphinx/source/bpdb.rst
@@ -0,0 +1,17 @@
+.. _bpdb:
+
+bpdb
+====
+
+To enable bpython support within pdb, start pdb with the following code:
+
+.. code-block:: python
+
+    import bpdb
+    bpdb.set_trace()
+
+This will drop you into bpdb instead of pdb, which works exactly like pdb except
+that you can additionally start bpython at the current stack frame by issuing
+the command `Bpython` or `B`.
+
+You can exit bpython with `^D` to return to bpdb.
diff --git a/doc/sphinx/source/index.rst b/doc/sphinx/source/index.rst
@@ -26,3 +26,4 @@ Contents:
    sourcecode
    bpaste
    tips
+   bpdb

-Original file line number
+Diff line change
    sourcecode
    bpaste
    tips
 +   bpdb