Browse Source

Merge pull request #619 from qpleple/doc

Doc formatting
Thomas 13 years ago
parent
commit
89b8a91ed8
2 changed files with 13 additions and 10 deletions
  1. 4 4
      Resources/doc/index.rst
  2. 9 6
      Resources/doc/reference/installation.rst

+ 4 - 4
Resources/doc/index.rst

@@ -4,11 +4,11 @@ Admin Bundle
 **SonataAdminBundle is split into 4 bundles:**
 **SonataAdminBundle is split into 4 bundles:**
 
 
 * SonataAdminBundle: contains core libraries and services
 * SonataAdminBundle: contains core libraries and services
-* `SonataDoctrineORMAdminBundle <https://github.com/sonata-project/SonataDoctrineORMAdminBundle>`_: Integrates Doctrine ORM project with the core admin bundle
-* `SonataDoctrineMongoDBAdminBundle <https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle>`_: Integrates MongoDB with the core admin bundle (early stage)
-* `SonataDoctrinePhpcrAdminBundle <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle>`_: Integrates PHPCR with the core admin bundle (early stage)
+* `SonataDoctrineORMAdminBundle <https://github.com/sonata-project/SonataDoctrineORMAdminBundle>`_: integrates Doctrine ORM project with the core admin bundle
+* `SonataDoctrineMongoDBAdminBundle <https://github.com/sonata-project/SonataDoctrineMongoDBAdminBundle>`_: integrates MongoDB with the core admin bundle (early stage)
+* `SonataDoctrinePhpcrAdminBundle <https://github.com/sonata-project/SonataDoctrinePhpcrAdminBundle>`_: integrates PHPCR with the core admin bundle (early stage)
 
 
-The demo website can be found in http://demo.sonata-project.org/admin/dashboard (admin as user and password)
+The demo website can be found in http://demo.sonata-project.org/admin/dashboard (admin as user and password).
 
 
 Reference Guide
 Reference Guide
 ---------------
 ---------------

+ 9 - 6
Resources/doc/reference/installation.rst

@@ -4,7 +4,7 @@ Installation
 Prerequisites
 Prerequisites
 -------------
 -------------
 
 
-**Translations**
+**Translations.**
 If you wish to use default translation texts provided in this bundle, you have
 If you wish to use default translation texts provided in this bundle, you have
 to make sure you have translator enabled in your config.
 to make sure you have translator enabled in your config.
 
 
@@ -20,7 +20,9 @@ Installation
 
 
 Download SonataAdminBundle and its dependencies to the ``vendor`` directory. You
 Download SonataAdminBundle and its dependencies to the ``vendor`` directory. You
 can use the Symfony's vendor script for the automated procces. Add the following
 can use the Symfony's vendor script for the automated procces. Add the following
-in your ``deps`` file::
+in your ``deps`` file:
+
+.. code-block:: ini
 
 
   [SonataAdminBundle]
   [SonataAdminBundle]
       git=http://github.com/sonata-project/SonataAdminBundle.git
       git=http://github.com/sonata-project/SonataAdminBundle.git
@@ -84,12 +86,13 @@ files:
         );
         );
     }
     }
 
 
-Now, install the assets from the bundles:
-``php app/console assets:install web``.
+Now, install the assets from the bundles::
+
+    php app/console assets:install web
 
 
-Usually when installing new bundles a good practice is also to delete your cache:
-``php app/console cache:clear``.
+Usually when installing new bundles a good practice is also to delete your cache::
 
 
+    php app/console cache:clear
 
 
 After you have successfully installed above bundles you need to configure
 After you have successfully installed above bundles you need to configure
 SonataAdminBundle for administering your models. All that is needed to quickly
 SonataAdminBundle for administering your models. All that is needed to quickly