From: Thomas Fillon Date: Tue, 1 Oct 2013 12:29:13 +0000 (+0200) Subject: Fix reST markup in doc/README.rst X-Git-Tag: 0.5.0~54 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=5b8bfb78f634bb9bb7cdf03ba79bc667e2858a33;p=timeside.git Fix reST markup in doc/README.rst --- diff --git a/doc/README.rst b/doc/README.rst index bd4c523..5bef300 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -10,7 +10,7 @@ To build *TimeSide* documentation, you need first to install *Sphinx* and its *n Installing Sphinx ----------------- -For accessing more complete instructions to install Sphinx on every platform see http://sphinx-doc.org/latest/install.html +For more complete instructions to install Sphinx on every platform see http://sphinx-doc.org/latest/install.html Debian/Ubuntu: Install Sphinx using packaging system @@ -25,13 +25,13 @@ You may install using this command if you use Debian/Ubuntu. Installing Sphinx with easy_install ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you have *easy-install* on your system you can install Sphinx with : +If you have *easy-install* on your system you can install Sphinx with: .. code-block:: bash $ easy_install sphinx -After installation, type :command:`sphinx-build` on the command prompt. If +After installation, type ``sphinx-build`` on the command prompt. If everything worked fine, you will get a Sphinx version number and a list of options for this command. @@ -41,7 +41,7 @@ Installing Sphinx extension Numpydoc *Numpydoc* is a Sphinx extension to support docstrings in Numpy format see https://pypi.python.org/pypi/numpydoc -It can be *easilly install* with:: +It can be *easilly install* with: .. code-block:: bash @@ -51,14 +51,14 @@ It can be *easilly install* with:: Building the doc ================ -From the ``doc`` directory, you need to run the following command to generate the HTML docs in the ``build`` directory:: +From the ``doc`` directory, you need to run the following command to generate the HTML docs in the ``build`` directory: .. code-block:: bash $ make html -*Doctest* can be performed by:: +*Doctest* can be performed by: .. code-block:: bash