Doc tweaks

Author: edschofield

docs/conf.py

@@ -121,7 +121,7 @@
     ],
 
     # Render the next and previous page links in navbar. (Default: true)
-    'navbar_sidebarrel': True,
+    'navbar_sidebarrel': False,
 
     # Render the current pages TOC in the navbar. (Default: true)
     'navbar_pagenav': True,

docs/contents.rst.inc

@@ -7,11 +7,11 @@ Contents:
    overview
    whatsnew
    quickstart
+   compatible_idioms
    imports
    standard_library_imports
    what_else
    automatic_conversion
-   compatible_idioms
    futurize_cheatsheet
    stdlib_incompatibilities
    faq

docs/futurize.rst

@@ -3,7 +3,9 @@
 Futurize: 2 to both
 --------------------
 
-For example, running ``futurize`` turns this Python 2 code::
+For example, running ``futurize`` turns this Python 2 code:
+
+.. code-block:: python
 
     import ConfigParser                 # Py2 module name
 
@@ -20,7 +22,9 @@ For example, running ``futurize`` turns this Python 2 code::
     for letter in itr:
         print letter,                   # Py2-style print statement
 
-into this code which runs on both Py2 and Py3::
+into this code which runs on both Py2 and Py3:
+
+.. code-block:: python
 
     from __future__ import print_function
     from future import standard_library
@@ -72,6 +76,7 @@ up-to-date without breaking Py2 compatibility. The resulting code will be
 modern Python 2.6-compatible code plus ``__future__`` imports from the
 following set::
 
+.. code-block:: python
     from __future__ import absolute_import
     from __future__ import division
     from __future__ import print_function
@@ -119,7 +124,9 @@ porting process, but without introducing any bugs. It should be uncontroversial
 and safe to apply to every Python 2 package. The subsequent patches introducing
 Python 3 compatibility should then be shorter and easier to review.
 
-The complete set of fixers applied by ``futurize --stage1`` is::
+The complete set of fixers applied by ``futurize --stage1`` is:
+
+.. code-block:: python
 
     lib2to3.fixes.fix_apply
     lib2to3.fixes.fix_except

docs/quickstart.rst

@@ -45,6 +45,7 @@ provide support for running your code on Python 2.6 and 2.7 mostly unchanged.
 - For more examples, see :ref:`overview`.
 - For explicit import forms, see :ref:`imports`.
 - For more details, see :ref:`what-else`.
+- For a cheat sheet, see :ref:`compatible-idioms`.
 
 
 To convert existing Python 3 code
@@ -152,5 +153,6 @@ For more information on the automatic translation feature, see :ref:`translation
 
 Next steps
 ----------
-For more information about writing Py3/2-compatible code, see :ref:`what-else`.
+For more information about writing Py2/3-compatible code, see
+:ref:`compatible-idioms` and :ref:`what-else`.
 

docs/stdlib_incompatibilities.rst

@@ -1,12 +1,5 @@
 .. _stdlib-incompatibilities:
 
-Use of strings and bytes in standard library interfaces
-=======================================================
-
-- io.StringIO: takes a unicode on both Py2 and Py3
-- io.BytesIO: takes a byte-string on both Py2 and Py3
-
-
 Standard library incompatibilities
 ==================================