From 605cc84a3f8444e00676d29d70167201e89cf315 Mon Sep 17 00:00:00 2001 From: Guilhem N Date: Tue, 9 Jan 2018 13:22:28 +0100 Subject: [PATCH] Fix links --- Resources/doc/index.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst index 69421a0..bf4907f 100644 --- a/Resources/doc/index.rst +++ b/Resources/doc/index.rst @@ -95,7 +95,7 @@ Using the bundle ---------------- You can configure global information in the bundle configuration ``documentation.info`` section (take a look at -[the Swagger specification](http://swagger.io/specification/) to know the fields +`the Swagger specification`_ to know the fields available): .. code-block:: yaml @@ -107,6 +107,8 @@ available): description: This is an awesome app! version: 1.0.0 +.. _`The Swagger specification`: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md + .. note:: If you're using Flex, this config is there by default. Don't forget to adapt it to your app! @@ -227,10 +229,8 @@ It has two options: If you're not using the JMS Serializer ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The [Symfony PropertyInfo component](https://symfony.com/doc/current/components/property_info.html) -is used to describe your models. It supports doctrine annotations, type hints, -and even PHP doc blocks as long as you required the -``phpdocumentor/reflection-docblock`` library. It does also support +The `Symfony PropertyInfo component`_ is used to describe your models. It supports doctrine annotations, type hints, +and even PHP doc blocks as long as you required the ``phpdocumentor/reflection-docblock`` library. It does also support serialization groups when using the Symfony serializer. If you're using the JMS Serializer @@ -240,7 +240,7 @@ The metadata of the JMS serializer are used by default to describe your models. Additional information is extracted from the PHP doc block comment, but the property types must be specified in the JMS annotations. -In case you prefer using the [Symfony PropertyInfo component](https://symfony.com/doc/current/components/property_info.html) (you +In case you prefer using the `Symfony PropertyInfo component`_ (you won't be able to use JMS serialization groups), you can disable JMS serializer support in your config: @@ -258,3 +258,5 @@ If you need more complex features, take a look at: :maxdepth: 1 areas + +.. _`Symfony PropertyInfo component`: https://symfony.com/doc/current/components/property_info.html