From 63c5758070dd39a9a4dcf6e97025f712850d7e7f Mon Sep 17 00:00:00 2001 From: Marco Pivetta Date: Tue, 10 Sep 2013 15:54:40 -0700 Subject: [PATCH] Merge pull request #784 from eventhorizonpl/fix_docs fix documentation warnings p1 Conflicts: docs/en/reference/advanced-configuration.rst --- docs/en/index.rst | 3 ++- docs/en/reference/caching.rst | 2 +- docs/en/reference/configuration.rst | 2 +- docs/en/reference/faq.rst | 2 +- docs/en/toc.rst | 12 ++++++++---- 5 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/en/index.rst b/docs/en/index.rst index e71ea7a43..72cac5727 100644 --- 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 ` with answers to frequent questions. - The `Doctrine Mailing List `_ -- Internet Relay Chat (IRC) in `#doctrine on Freenode `_ +- Internet Relay Chat (IRC) in #doctrine on Freenode - Report a bug on `JIRA `_. - On `Twitter `_ with ``#doctrine2`` - On `StackOverflow `_ @@ -120,3 +120,4 @@ Cookbook :doc:`MySQL Enums ` :doc:`Advanced Field Value Conversion ` +.. include:: toc.rst diff --git a/docs/en/reference/caching.rst b/docs/en/reference/caching.rst index 1e87efaff..d45090cbc 100644 --- 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 `_. Also check -`here `_ for how you can use +`A PHP extension for Redis `_ 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 index d8e718b5c..4af53c4f0 100644 --- a/docs/en/reference/configuration.rst +++ b/docs/en/reference/configuration.rst @@ -100,7 +100,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 index 28e3a42c4..45fde18d7 100644 --- a/docs/en/reference/faq.rst +++ b/docs/en/reference/faq.rst @@ -143,7 +143,7 @@ See the documentation chapter on :doc:`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 index 73f1f25b9..1a331fa23 100644 --- 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,6 +65,7 @@ Cookbook :maxdepth: 1 cookbook/aggregate-fields + cookbook/custom-mapping-types cookbook/decorator-pattern cookbook/dql-custom-walkers cookbook/dql-user-defined-functions @@ -70,6 +73,7 @@ Cookbook 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