Clean and reorganise a bit the documentation

1 files changed, 24 insertions, 26 deletions

diff --git a/docs/contributing.rst b/docs/contributing.rst
index d46c9ec..ef6e24c 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -49,16 +49,18 @@ In case you want to update to newer versions (from git), you can just run the "u
 Create database migrations
 --------------------------
 
-In case you need to modify the database schema, first update the models in ihatemoney/models.py.
-Then run the following command to create a new database revision file::
+In case you need to modify the database schema, first update the models in
+``ihatemoney/models.py``. Then run the following command to create a new
+database revision file::
 
   make create-database-revision
 
 If your changes are simple enough, the generated script will be populated with
-the necessary migrations steps. You can edit the generated script. eg: to add data migrations.
+the necessary migrations steps. You can edit the generated script. eg: to add
+data migrations.
 
-For complex migrations, it is recommended to start from an empty revision file which can be created
-with the following command::
+For complex migrations, it is recommended to start from an empty revision file
+which can be created with the following command::
 
   make create-empty-database-revision
 
@@ -75,7 +77,7 @@ You can also set the `TESTING` flag to `True` so no mails are sent
 (and no exception is raised) while you're on development mode.
 Then before running the application, declare its path with ::
 
-    $ export IHATEMONEY_SETTINGS_FILE_PATH="$(pwd)/settings.cfg"
+  export IHATEMONEY_SETTINGS_FILE_PATH="$(pwd)/settings.cfg"
 
 How to contribute
 =================
@@ -89,8 +91,8 @@ a developer or an user.
 As a developer
 --------------
 
-If you want to contribute code, you can write it and then issue a pull request on
-github. Please, think about updating and running the tests before asking for
+If you want to contribute code, you can write it and then issue a pull request
+on github. Please, think about updating and running the tests before asking for
 a pull request as it will help us to maintain the code clean and running.
 
 To do so::
@@ -109,14 +111,14 @@ As a translator
 
 Collect all new strings to translate::
 
-  $ make update-translations
+  make update-translations
 
- Add missing translations to *.po* files inside *translations/* dir using your
- favorite text editor.
+Add missing translations to *.po* files inside *translations/* dir using your
+favorite text editor.
 
- Compile them into *.mo* files::
+Compile them into *.mo* files::
 
-  $ make build-translations
+  make build-translations
 
 Commit both *.mo* and *.po*.
 
@@ -125,8 +127,8 @@ End-user
 
 You are using the application and found a bug? You have some ideas about how to
 improve the project? Please tell us `by filling a new issue <https://github.com/spiral-project/ihatemoney/issues>`_.
-Or, if you prefer, you can send me an email to `alexis@notmyidea.org` and I will
-update the issue tracker with your feedback.
+Or, if you prefer, you can send me an email to `alexis@notmyidea.org` and I
+will update the issue tracker with your feedback.
 
 Thanks again!
 
@@ -154,22 +156,18 @@ In order to prepare a new release, we are following the following steps:
 - Merge remaining pull requests;
 - Update :file:`CHANGELOG.rst` with the last changes;
 - Update :file:`CONTRIBUTORS`;
-- Update known good versions of dependencies in ``requirements.txt`` with this command (from inside the venv):
+- Update known good versions of dependencies in ``requirements.txt`` with this
+  command (from inside the venv)::
 
-.. code-block:: bash
+    make build-requirements
 
-     $ make build-requirements
-- If needed, recompress assets. It requires zopflipng:
+- If needed, recompress assets. It requires zopflipng::
 
-.. code-block:: bash
+    make compress-assets
 
-     $ make compress-assets
+Once this is done, use the "release" instruction::
 
-Once this is done, use the "release" instruction:
-
-.. code-block:: bash
-
-     $ make release
+    make release
 
 And the new version should be published on PyPI.