Make the shell be in code blocks and add a section about building the documentation.

ikanobori · ikanobori · commit f4a997da82e6 · 2014-08-11T16:35:12.000+02:00
diff --git a/doc/sphinx/source/contributing.rst b/doc/sphinx/source/contributing.rst
@@ -18,17 +18,23 @@ Getting your development environment set up
 
 Using a virtual environment is probably a good idea. Create a virtual environment with
 
+.. code-block:: bash
+
     $ virtualenv bpython-dev
     $ source bpython-dev/bin/activate   # this step is necssary every time you work on bpython
     <hack on bpython>
     $ deactivate                        # back to normal system environment
 
 Fork bpython in the GitHub web interace, then clone the repo:
 
+.. code-block:: bash
+
     $ git clone git@github.com:YOUR_GITHUB_USERNAME/bpython.git
 
 Next install this development version of bpython:
 
+.. code-block:: bash
+
     $ pip install pygments curtsies greenlet watchdog urwid  # install all the dependencies
     $ pip install sphinx mock                                # development dependencies
     $ cd bpython
@@ -45,7 +51,20 @@ To run tests:
 To build the docs:
 ------------------
 
-TODO
+The documentation is included in the regular `bpython` repository so if you did the
+previous step your install can support generating and working on the documentation.
+
+Install `sphinx` (or in your current `virtualenv`). And go to the following directory:
+
+.. code-block:: bash
+
+    $ pip install sphinx
+    $ cd bpython/doc/sphinx/ # assuming you are in the root dir of the bpython project
+    $ make html
+
+Afterwards you can point your browser to `bpython/doc/source/index.html`. Don't forget
+to recreate the HTML after you make changes.
+
 
 To hack on the site:
 --------------------
