From 0f97cf8bb3e95704a908b925a70a8f0c573f098c Mon Sep 17 00:00:00 2001 From: "Daniel G. Taylor" Date: Thu, 5 Feb 2015 15:23:14 -0800 Subject: [PATCH] Readme consistency and more syntax highlighting --- README.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index cceeff9c6a..2c92583971 100644 --- a/README.rst +++ b/README.rst @@ -40,7 +40,9 @@ pull requests on this repository. Thanks! Quick Start ----------- -First, install the library and set a default region:: +First, install the library and set a default region: + +.. code-block:: sh $ pip install boto3 @@ -75,7 +77,9 @@ Getting Started ~~~~~~~~~~~~~~~ Assuming that you have Python and ``virtualenv`` installed, set up your environment and install the required dependencies like this instead of -the ``pip install boto3`` defined above:: +the ``pip install boto3`` defined above: + +.. code-block:: sh $ git clone https://github.com/boto/boto3.git $ cd boto3 @@ -91,20 +95,26 @@ You can run tests in all supported Python versions using ``tox``. Be default, it will run all of the unit tests, but you can also specify your own ``nosetests`` options. Note that this requires that you have all supported versions of Python installed, otherwise you must pass ``-e`` or run the -``nosetests`` command directly:: +``nosetests`` command directly: + +.. code-block:: sh $ tox $ tox tests/unit/test_session.py $ tox -e py26,py33 tests/integration -You can also run individual tests with your default Python version:: +You can also run individual tests with your default Python version: + +.. code-block:: sh $ nosetests tests/unit Generating Documentation ~~~~~~~~~~~~~~~~~~~~~~~~ Sphinx is used for documentation. You can generate HTML locally with the -following:: +following: + +.. code-block:: sh $ pip install sphinx sphinx_rtd_theme $ cd docs