minor #4106 removed references to documentation from external sources (fabpot, WouterJ)

fabpot · fabpot · commit 41bc061762b8 · 2014-11-11T09:25:32.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- removed references to documentation from external sources | Q | A | ------------- | --- | Doc fix? | n/a | New docs? | n/a | Applies to | all | Fixed tickets | n/a Referencing external doc sources was a mistake as the versioning can be (and is) different from the versioning of the Symfony docs. **WARNING** I will merge this one myself to coordinate the merge with the release of the new frontend on symfony.com. Commits ------- 2cb8d27 removed more references to documentation from external sources c39ea1d Removed more references to third party docs 0e2c491 removed references to documentation from external sources
diff --git a/.gitignore b/.gitignore
@@ -1,8 +1,2 @@
 /_build
-/bundles/DoctrineFixturesBundle
-/bundles/DoctrineMigrationsBundle
-/bundles/DoctrineMongoDBBundle
-/bundles/SensioFrameworkExtraBundle
-/bundles/SensioGeneratorBundle
-/cmf
 /_exts
diff --git a/.travis.yml b/.travis.yml
@@ -4,7 +4,6 @@ python:
     - "2.7"
 
 install: 
-    - "bash install.sh"
     - "pip install -q -r requirements.txt --use-mirrors"
 
 script: sphinx-build -nW -b html -d _build/doctrees . _build/html
diff --git a/book/doctrine.rst b/book/doctrine.rst
@@ -22,7 +22,7 @@ can be.
     easy, and explained in the ":doc:`/cookbook/doctrine/dbal`" cookbook entry.
 
     You can also persist data to `MongoDB`_ using Doctrine ODM library. For
-    more information, read the ":doc:`/bundles/DoctrineMongoDBBundle/index`"
+    more information, read the "`DoctrineMongoDBBundle`_"
     documentation.
 
 A Simple Example: A Product
@@ -471,10 +471,10 @@ in your application. To do this, run:
     new column to the existing ``product`` table.
 
     An even better way to take advantage of this functionality is via
-    :doc:`migrations </bundles/DoctrineMigrationsBundle/index>`, which allow you to
-    generate these SQL statements and store them in migration classes that
-    can be run systematically on your production server in order to track
-    and migrate your database schema safely and reliably.
+    `migrations`_, which allow you to generate these SQL statements and store
+    them in migration classes that can be run systematically on your production
+    server in order to track and migrate your database schema safely and
+    reliably.
 
 Your database now has a fully-functional ``product`` table with columns that
 match the metadata you've specified.
@@ -559,7 +559,7 @@ an ``UPDATE`` query if the record already exists in the database.
 
     Doctrine provides a library that allows you to programmatically load testing
     data into your project (i.e. "fixture data"). For information, see
-    :doc:`/bundles/DoctrineFixturesBundle/index`.
+    the "`DoctrineFixturesBundle`_" documentation.
 
 Fetching Objects from the Database
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -586,8 +586,7 @@ on its ``id`` value::
 .. tip::
 
     You can achieve the equivalent of this without writing any code by using
-    the ``@ParamConverter`` shortcut. See the
-    :doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/converters>`
+    the ``@ParamConverter`` shortcut. See the `FrameworkExtraBundle documentation`_
     for more details.
 
 When you query for a particular type of object, you always use what's known
@@ -1083,7 +1082,7 @@ table, and ``product.category_id`` column, and new foreign key:
 
     This task should only be really used during development. For a more robust
     method of systematically updating your production database, read about
-    :doc:`Doctrine migrations </bundles/DoctrineMigrationsBundle/index>`.
+    `migrations`_.
 
 Saving Related Entities
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -1400,8 +1399,8 @@ For more information about Doctrine, see the *Doctrine* section of the
 
 * :doc:`/cookbook/doctrine/common_extensions`
 * :doc:`/cookbook/doctrine/console`
-* :doc:`/bundles/DoctrineFixturesBundle/index`
-* :doc:`/bundles/DoctrineMongoDBBundle/index`
+* `DoctrineFixturesBundle`_
+* `DoctrineMongoDBBundle`_
 
 .. _`Doctrine`: http://www.doctrine-project.org/
 .. _`MongoDB`: http://www.mongodb.org/
@@ -1414,3 +1413,7 @@ For more information about Doctrine, see the *Doctrine* section of the
 .. _`Lifecycle Events documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#lifecycle-events
 .. _`Reserved SQL keywords documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#quoting-reserved-words
 .. _`Persistent classes`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#persistent-classes
+.. _`DoctrineMongoDBBundle`: http://symfony.com/doc/current/bundles/DoctrineMongoDBBundle/index.html
+.. _`migrations`: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
+.. _`DoctrineFixturesBundle`: http://symfony.com/doc/current/bundles/DoctrineFixturesBundle/index.html
+.. _`FrameworkExtraBundle documentation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
diff --git a/book/http_cache.rst b/book/http_cache.rst
@@ -764,7 +764,7 @@ at some interval (the expiration) to verify that the content is still valid.
 
     You can also define HTTP caching headers for expiration and validation by using
     annotations. See the
-    :doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/cache>`.
+    `FrameworkExtraBundle documentation <http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/cache.html>`_.
 
 .. index::
     pair: Cache; Configuration
diff --git a/bundles/index.rst b/bundles/index.rst
diff --git a/bundles/map.rst.inc b/bundles/map.rst.inc
diff --git a/components/http_kernel/introduction.rst b/components/http_kernel/introduction.rst
@@ -288,16 +288,15 @@ on the event object that's passed to listeners on this event.
     the Symfony Framework, and many deal with collecting profiler data when
     the profiler is enabled.
 
-    One interesting listener comes from the :doc:`SensioFrameworkExtraBundle </bundles/SensioFrameworkExtraBundle/index>`,
+    One interesting listener comes from the `SensioFrameworkExtraBundle`_,
     which is packaged with the Symfony Standard Edition. This listener's
-    :doc:`@ParamConverter </bundles/SensioFrameworkExtraBundle/annotations/converters>`
-    functionality allows you to pass a full object (e.g. a ``Post`` object)
-    to your controller instead of a scalar value (e.g. an ``id`` parameter
-    that was on your route). The listener - ``ParamConverterListener`` - uses
-    reflection to look at each of the arguments of the controller and tries
-    to use different methods to convert those to objects, which are then
-    stored in the ``attributes`` property of the ``Request`` object. Read the
-    next section to see why this is important.
+    `@ParamConverter`_ functionality allows you to pass a full object (e.g. a
+    ``Post`` object) to your controller instead of a scalar value (e.g. an
+    ``id`` parameter that was on your route). The listener -
+    ``ParamConverterListener`` - uses reflection to look at each of the
+    arguments of the controller and tries to use different methods to convert
+    those to objects, which are then stored in the ``attributes`` property of
+    the ``Request`` object. Read the next section to see why this is important.
 
 4) Getting the Controller Arguments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -395,14 +394,12 @@ return a ``Response``.
 .. sidebar:: ``kernel.view`` in the Symfony Framework
 
     There is no default listener inside the Symfony Framework for the ``kernel.view``
-    event. However, one core bundle -
-    :doc:`SensioFrameworkExtraBundle </bundles/SensioFrameworkExtraBundle/index>` -
-    *does* add a listener to this event. If your controller returns an array,
-    and you place the :doc:`@Template </bundles/SensioFrameworkExtraBundle/annotations/view>`
-    annotation above the controller, then this listener renders a template,
-    passes the array you returned from your controller to that template,
-    and creates a ``Response`` containing the returned content from that
-    template.
+    event. However, one core bundle - `SensioFrameworkExtraBundle`_ - *does*
+    add a listener to this event. If your controller returns an array,
+    and you place the `@Template`_ annotation above the controller, then this
+    listener renders a template, passes the array you returned from your
+    controller to that template, and creates a ``Response`` containing the
+    returned content from that template.
 
     Additionally, a popular community bundle `FOSRestBundle`_ implements
     a listener on this event which aims to give you a robust view layer
@@ -699,3 +696,6 @@ look like this::
 .. _FOSRestBundle: https://github.com/friendsofsymfony/FOSRestBundle
 .. _`Create your own framework... on top of the Symfony2 Components`: http://fabien.potencier.org/article/50/create-your-own-framework-on-top-of-the-symfony2-components-part-1
 .. _`PHP FPM`: http://php.net/manual/en/install.fpm.php
+.. _`SensioFrameworkExtraBundle`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
+.. _`@ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
+.. _`@Template`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/view.html
diff --git a/contributing/documentation/format.rst b/contributing/documentation/format.rst
@@ -209,7 +209,6 @@ submitting your documentation, follow these steps:
 
 * Install Sphinx_;
 * Install the Sphinx extensions using git submodules: ``$ git submodule update --init``;
-* (Optionally) Install the bundle docs and CMF docs: ``$ bash install.sh``;
 * Run ``make html`` and view the generated HTML in the ``build/`` directory.
 
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html
diff --git a/cookbook/controller/service.rst b/cookbook/controller/service.rst
@@ -132,9 +132,8 @@ the route ``_controller`` value:
 .. tip::
 
     You can also use annotations to configure routing using a controller
-    defined as a service. See the
-    :doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/routing>`
-    for details.
+    defined as a service. See the `FrameworkExtraBundle documentation`_ for
+    details.
 
 Alternatives to base Controller Methods
 ---------------------------------------
@@ -267,3 +266,4 @@ inject *only* the exact service(s) that you need directly into the controller.
 
 .. _`Controller class source code`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
 .. _`base Controller class`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
+.. _`FrameworkExtraBundle documentation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/routing.html
diff --git a/cookbook/templating/PHP.rst b/cookbook/templating/PHP.rst
@@ -60,11 +60,10 @@ below renders the ``index.html.php`` template::
         );
     }
 
-You can also use the :doc:`/bundles/SensioFrameworkExtraBundle/annotations/view`
-shortcut to render the default ``AcmeHelloBundle:Hello:index.html.php`` template::
+You can also use the `@Template`_ shortcut to render the default
+``AcmeHelloBundle:Hello:index.html.php`` template::
 
     // src/Acme/HelloBundle/Controller/HelloController.php
-
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
 
     // ...
@@ -353,3 +352,5 @@ within an HTML context. The second argument lets you change the context. For
 instance, to output something in a JavaScript script, use the ``js`` context::
 
     <?php echo $view->escape($var, 'js') ?>
+
+.. _`@Template`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/view`
diff --git a/index.rst b/index.rst
@@ -77,29 +77,6 @@ Get answers quickly with reference documents:
 
 .. include:: /reference/map.rst.inc
 
-Bundles
--------
-
-The Symfony Standard Edition comes with some bundles. Learn more about them:
-
-.. toctree::
-    :hidden:
-
-    bundles/index
-
-.. include:: /bundles/map.rst.inc
-
-CMF
----
-
-The Symfony CMF project makes it easier for developers to add CMS functionality
-to applications built with the Symfony PHP framework.
-
-.. toctree::
-    :hidden:
-
-    cmf/index
-
 Contributing
 ------------
 
diff --git a/install.sh b/install.sh
