Merge pull request doctrine#784 from eventhorizonpl/fix_docs

fix documentation warnings p1
vend · Sep 10, 2013 · bb7f18c · bb7f18c
2 parents 9983fcb + bc37ceb
commit bb7f18c
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 13 deletions.
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -14,7 +14,7 @@ Doctrine ORM don't panic. You can get help from different sources:
 
 -  There is a :doc:`FAQ <reference/faq>` with answers to frequent questions.
 -  The `Doctrine Mailing List <http://groups.google.com/group/doctrine-user>`_
--  Internet Relay Chat (IRC) in `#doctrine on Freenode <irc://irc.freenode.net/doctrine>`_
+-  Internet Relay Chat (IRC) in #doctrine on Freenode
 -  Report a bug on `JIRA <http://www.doctrine-project.org/jira>`_.
 -  On `Twitter <https://twitter.com/search/%23doctrine2>`_ with ``#doctrine2``
 -  On `StackOverflow <http://stackoverflow.com/questions/tagged/doctrine2>`_
@@ -120,3 +120,4 @@ Cookbook
   :doc:`MySQL Enums <cookbook/mysql-enums>`
   :doc:`Advanced Field Value Conversion <cookbook/advanced-field-value-conversion-using-custom-mapping-types>`
 
+.. include:: toc.rst
diff --git a/docs/en/reference/advanced-configuration.rst b/docs/en/reference/advanced-configuration.rst
@@ -373,15 +373,15 @@ using the Doctrine Console:
 The other options are interesting in development environment:
 
 - ``AUTOGENERATE_ALWAYS`` will require you to create and configure
-a proxy directory. Proxies will be generated and written to file
-on each request, so any modification to your code will be acknowledged.
+  a proxy directory. Proxies will be generated and written to file
+  on each request, so any modification to your code will be acknowledged.
 
 - ``AUTOGENERATE_FILE_NOT_EXISTS`` will not overwrite an existing
-proxy file. If your code changes, you will need to regenerate the
-proxies manually.
+  proxy file. If your code changes, you will need to regenerate the
+  proxies manually.
 
 - ``AUTOGENERATE_EVAL`` will regenerate each proxy on each request,
-but without writing them to disk.
+  but without writing them to disk.
 
 Autoloading Proxies
 -------------------

diff --git a/docs/en/reference/caching.rst b/docs/en/reference/caching.rst
@@ -106,7 +106,7 @@ Redis
 In order to use the Redis cache driver you must have it compiled
 and enabled in your php.ini. You can read about what is Redis
 `from here <http://redis.io/>`_. Also check
-`here <https://github.com/nicolasff/phpredis/>`_ for how you can use
+`A PHP extension for Redis <https://github.com/nicolasff/phpredis/>`_ for how you can use
 and install Redis PHP extension.
 
 Below is a simple example of how you could use the Redis cache

diff --git a/docs/en/reference/configuration.rst b/docs/en/reference/configuration.rst
@@ -101,7 +101,7 @@ Doctrine ships with a number of command line tools that are very helpful
 during development. You can call this command from the Composer binary
 directory:
 
-.. code-block::
+.. code-block:: sh
 
     $ php vendor/bin/doctrine
 

diff --git a/docs/en/reference/faq.rst b/docs/en/reference/faq.rst
@@ -143,7 +143,7 @@ See the documentation chapter on :doc:`inheritance mapping <inheritance-mapping>
 the details.
 
 Why does Doctrine not create proxy objects for my inheritance hierarchy?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 If you set a many-to-one or one-to-one association target-entity to any parent class of
 an inheritance hierarchy Doctrine does not know what PHP class the foreign is actually of.

diff --git a/docs/en/toc.rst b/docs/en/toc.rst
@@ -8,12 +8,14 @@ Tutorials
    :maxdepth: 1
 
    tutorials/getting-started
+   tutorials/getting-started-database
+   tutorials/getting-started-models
    tutorials/working-with-indexed-associations
    tutorials/extra-lazy-associations
    tutorials/composite-primary-keys
    tutorials/ordered-associations
-   tutorials/in-ten-quick-steps
    tutorials/override-field-association-mappings-in-subclasses
+   tutorials/pagination.rst
 
 Reference Guide
 ---------------
@@ -22,9 +24,9 @@ Reference Guide
    :maxdepth: 1
    :numbered:
 
-   reference/introduction
    reference/architecture
-   reference/configuration
+   reference/installation
+   reference/configuration.rst
    reference/faq
    reference/basic-mapping
    reference/association-mapping
@@ -51,9 +53,9 @@ Reference Guide
    reference/metadata-drivers
    reference/best-practices
    reference/limitations-and-known-issues
-   tutorials/pagination.rst
    reference/filters.rst
    reference/namingstrategy.rst
+   reference/advanced-configuration.rst
 
 
 Cookbook
@@ -63,13 +65,15 @@ Cookbook
    :maxdepth: 1
 
    cookbook/aggregate-fields
+   cookbook/custom-mapping-types
    cookbook/decorator-pattern
    cookbook/dql-custom-walkers
    cookbook/dql-user-defined-functions
    cookbook/implementing-arrayaccess-for-domain-objects
    cookbook/implementing-the-notify-changetracking-policy
    cookbook/implementing-wakeup-or-clone
    cookbook/integrating-with-codeigniter
+   cookbook/resolve-target-entity-listener
    cookbook/sql-table-prefixes
    cookbook/strategy-cookbook-introduction
    cookbook/validation-of-entities