Update documentation

sebastinas · sebastinas · commit ee48fb3d429d · 2015-02-09T18:53:47.000+01:00
Signed-off-by: Sebastian Ramacher &lt;sebastian+dev@ramacher.at&gt;
diff --git a/doc/sphinx/source/contributing.rst b/doc/sphinx/source/contributing.rst
@@ -10,52 +10,52 @@ these are particularly good ones to start out with.
 
 See our section about the :ref:`community` for a list of resources.
 
-`#bpython` on freenode is particularly useful, but you might have to wait for a while
-to get a question answered depending on the time of day.
+`#bpython` on freenode is particularly useful, but you might have to wait for a
+while to get a question answered depending on the time of day.
 
 Getting your development environment set up
 -------------------------------------------
 
-bpython supports Python 2.6, 2.7, 3.3 and 3.4. The code is written in Python
-2 and transformed for Python 3 with 2to3. This means that it's easier
-to work on bpython with Python 2 because you can use ``python setup.py develop``
-or ``pip install -e .``
-(`development mode
-<https://pythonhosted.org/setuptools/setuptools.html#development-mode>`_ installs
-by linking to the bpython source instead of copying it over)
-in a more straightforward way to have your changes immediately reflected by
-your bpython installation and the `bpython`, `bpython-curses`, and `bpython-urwid`
-commands.
+bpython supports Python 2.6, 2.7, 3.3 and 3.4. The code is compatible with all
+supported versions without the need to run post processing like `2to3`.
 
-Using a virtual environment is probably a good idea. Create a virtual environment with
+Using a virtual environment is probably a good idea. Create a virtual
+environment with
 
 .. code-block:: bash
 
-    $ virtualenv bpython-dev            # determines Python version used
-    $ source bpython-dev/bin/activate   # necessary every time you work on bpython
+    # determines Python version used
+    $ virtualenv bpython-dev
+    # necessary every time you work on bpython
+    $ source bpython-dev/bin/activate
 
 Fork bpython in the GitHub web interface, then clone the repo:
 
 .. code-block:: bash
 
     $ git clone git@github.com:YOUR_GITHUB_USERNAME/bpython.git
-    $ # or "git clone https://github.com/YOUR_GITHUB_USERNAME/bpython.git"
+    # or "git clone https://github.com/YOUR_GITHUB_USERNAME/bpython.git"
 
 Next install the install your development copy of bpython and its dependencies:
 
 .. code-block:: bash
 
     $ cd bpython
-    $ pip install -e .                       # install bpython and required dependencies
-    $ pip install watchdog urwid             # install optional dependencies
-    $ pip install sphinx mock nose           # development dependencies
+    # install bpython and required dependencies
+    $ pip install -e .
+    # install optional dependencies
+    $ pip install watchdog urwid
+    # development dependencies
+    $ pip install sphinx mock nose
     <modify a file in some way>
-    $ bpython                                # this runs your modified copy of bpython!
+    # this runs your modified copy of bpython!
+    $ bpython
 
 .. note::
 
     Many requirements are also available from your distribution's package
-    manager. On Debian/Ubuntu based systems, the following packages can be used:
+    manager. On Debian/Ubuntu based systems, the following packages can be
+    used:
 
     .. code-block:: bash
 
@@ -70,8 +70,8 @@ Next install the install your development copy of bpython and its dependencies:
 
 .. note::
 
-    Installation of some dependencies with ``pip`` requires Python headers and a
-    C compiler. These are also available from your package manager.
+    Installation of some dependencies with ``pip`` requires Python headers and
+    a C compiler. These are also available from your package manager.
 
     .. code-block:: bash
 
@@ -86,8 +86,8 @@ To run tests from the bpython directory:
 
     $ nosetests
 
-If you want to skip test cases that are known to be slow, run `nosetests` in the
-following way:
+If you want to skip test cases that are known to be slow, run `nosetests` in
+the following way:
 
 .. code-block:: bash
 
@@ -111,17 +111,17 @@ Don't forget to recreate the HTML after you make changes.
 Hacking on the site or theme
 ----------------------------
 
-The site (and its theme as well) is stored in a separate repository and built using
-pelican. To start hacking on the site you need to start out with a checkout and
-probably a virtual environment:
+The site (and its theme as well) is stored in a separate repository and built
+using pelican. To start hacking on the site you need to start out with a
+checkout and probably a virtual environment:
 
 .. code-block:: bash
 
     $ virtualenv bpython-site-dev
     $ source bpython-site-dev/bin/activate
     $ pip install pelican
 
-Fork bsite and bsite-theme in the GitHub web interface, then clone the 
+Fork bsite and bsite-theme in the GitHub web interface, then clone the
 repositories:
 
 .. code-block:: bash
@@ -136,11 +136,14 @@ included configuration file.
 .. code-block:: bash
 
     $ source bpython-site-dev/bin/activate
-    $ cd bsite # if you want to fiddle on the text of the site otherwise go into bsite-theme
-    $ pelican -t ../bsite-theme -s pelicanconf.py # if you checked out the theme in a different place, use that path
-
-After this you can open the `output/index.html` in your favourite browser and see
-if your changes had an effect.
+    # if you want to fiddle on the text of the site otherwise go into
+    # bsite-theme
+    $ cd bsite
+    # if you checked out the theme in a different place, use that path
+    $ pelican -t ../bsite-theme -s pelicanconf.py
+
+After this you can open the `output/index.html` in your favourite browser and
+see if your changes had an effect.
 
 .. _GitHub issue tracker: https://github.com/bpython/bpython/issues
 .. _bite-size: https://github.com/bpython/bpython/labels/bitesize
diff --git a/doc/sphinx/source/index.rst b/doc/sphinx/source/index.rst
@@ -1,8 +1,3 @@
-.. bpython documentation master file, created by
-   sphinx-quickstart on Mon Jun  8 11:58:16 2009.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 bpython documentation
 =====================
 Welcome to the bpython documentation files. This is where you
diff --git a/doc/sphinx/source/releases.rst b/doc/sphinx/source/releases.rst
@@ -16,17 +16,26 @@ After it is decided to release a new version of bpython the following checklist
 is followed:
 
 * The repository is frozen, nobody pushes until the version is built.
+
 * Bob (:ref:`authors`) makes a tarball of the new version and sends it to Simon
   (:ref:`authors`) who will host it on the bpython website.
+
 * The package is then downloaded by all of the people who like to test it.
+
 * Everybody checks if there are no great problems:
-  - Version numbers correct?
-  - CHANGELOG is correct?
-  - AUTHORS?
+
+  * Version numbers correct?
+
+  * CHANGELOG is correct?
+
+  * AUTHORS?
+
 * After everybody says 'yes' the website and PyPI are updated to point to this
   new version.
-  - Simon (:ref:`authors`) also checks if all numbers on the website have been
+
+  * Simon (:ref:`authors`) also checks if all numbers on the website have been
     updated.
+
 * 24 hours later package maintainers could update their stuff.
 
 Checklist
