Skip to content

Commit

Permalink
bug symfony#19298 Fix wrong reStructuredText references (wouterj)
Browse files Browse the repository at this point in the history
This PR was merged into the 5.4 branch.

Discussion
----------

Fix wrong reStructuredText references

Found while testing the phpDocumentor rst parser. The Doctrine parser is much more forgiving about this wrong references than Sphinx and phpDocumentor are.

Commits
-------

e671f57 Fix wrong reStructuredText references
  • Loading branch information
OskarStark committed Dec 16, 2023
2 parents 28992c9 + e671f57 commit 0e17d00
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ data.
Context
-------

Many Serializer features can be configured :doc:`using a context </serializer#serializer-context>`.
Many Serializer features can be configured :ref:`using a context <serializer_serializer-context>`.

.. _component-serializer-attributes-groups:

Expand Down
4 changes: 2 additions & 2 deletions configuration/multiple_kernels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ requirements, so it's up to you to decide which best suits your project.

First, create a new ``apps`` directory at the root of your project, which will
hold all the necessary applications. Each application will follow a simplified
directory structure like the one described in :ref:`Symfony Best Practice </best_practices>`:
directory structure like the one described in :doc:`Symfony Best Practice </best_practices>`:

.. code-block:: text
Expand Down Expand Up @@ -321,7 +321,7 @@ Rendering Templates
-------------------

Let's consider that you need to create another app called ``admin``. If you
follow the :ref:`Symfony Best Practices </best_practices>`, the shared Kernel
follow the :doc:`Symfony Best Practices </best_practices>`, the shared Kernel
templates will be located in the ``templates/`` directory at the project's root.
For admin-specific templates, you can create a new directory
``apps/admin/templates/`` which you will need to manually configure under the
Expand Down
26 changes: 13 additions & 13 deletions mailer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -174,19 +174,19 @@ transport, but you can force to use one:
This table shows the full list of available DSN formats for each third
party provider:

===================== ==================================================== =========================================== ========================================
Provider SMTP HTTP API
===================== ==================================================== =========================================== ========================================
`Amazon SES`_ ses+smtp://USERNAME:PASSWORD@default ses+https://ACCESS_KEY:SECRET_KEY@default ses+api://ACCESS_KEY:SECRET_KEY@default
`Google Gmail`_ gmail+smtp://USERNAME:APP-PASSWORD@default n/a n/a
`Mandrill`_ mandrill+smtp://USERNAME:PASSWORD@default mandrill+https://KEY@default mandrill+api://KEY@default
`Mailgun`_ mailgun+smtp://USERNAME:PASSWORD@default mailgun+https://KEY:DOMAIN@default mailgun+api://KEY:DOMAIN@default
`Mailjet`_ mailjet+smtp://ACCESS_KEY:SECRET_KEY@default n/a mailjet+api://ACCESS_KEY:SECRET_KEY@default
`Postmark`_ postmark+smtp://ID@default n/a postmark+api://KEY@default
`Sendgrid`_ sendgrid+smtp://KEY@default n/a sendgrid+api://KEY@default
`Sendinblue`_ sendinblue+smtp://USERNAME:PASSWORD@default n/a sendinblue+api://KEY@default
`OhMySMTP`_ ohmysmtp+smtp://API_TOKEN@default n/a ohmysmtp+api://API_TOKEN@default
===================== ==================================================== =========================================== ========================================
===================== ======================================================== =============================================== ============================================
Provider SMTP HTTP API
===================== ======================================================== =============================================== ============================================
`Amazon SES`_ ``ses+smtp://USERNAME:PASSWORD@default`` ``ses+https://ACCESS_KEY:SECRET_KEY@default`` ``ses+api://ACCESS_KEY:SECRET_KEY@default``
`Google Gmail`_ ``gmail+smtp://USERNAME:APP-PASSWORD@default`` n/a n/a
`Mandrill`_ ``mandrill+smtp://USERNAME:PASSWORD@default`` ``mandrill+https://KEY@default`` ``mandrill+api://KEY@default``
`Mailgun`_ ``mailgun+smtp://USERNAME:PASSWORD@default`` ``mailgun+https://KEY:DOMAIN@default`` ``mailgun+api://KEY:DOMAIN@default``
`Mailjet`_ ``mailjet+smtp://ACCESS_KEY:SECRET_KEY@default`` n/a ``mailjet+api://ACCESS_KEY:SECRET_KEY@default``
`Postmark`_ ``postmark+smtp://ID@default`` n/a ``postmark+api://KEY@default``
`Sendgrid`_ ``sendgrid+smtp://KEY@default`` n/a ``sendgrid+api://KEY@default``
`Sendinblue`_ ``sendinblue+smtp://USERNAME:PASSWORD@default`` n/a ``sendinblue+api://KEY@default``
`OhMySMTP`_ ``ohmysmtp+smtp://API_TOKEN@default`` n/a ``ohmysmtp+api://API_TOKEN@default``
===================== ======================================================== =============================================== ============================================

.. caution::

Expand Down
2 changes: 1 addition & 1 deletion mercure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ that handles persistent SSE connections with the clients.
The Symfony app publishes the updates to the hub, that will broadcast them to
clients.

Thanks to :ref:`the Docker integration of Symfony </setup/docker>`,
Thanks to :doc:`the Docker integration of Symfony </setup/docker>`,
:ref:`Flex <symfony-flex>` proposes to install a Mercure hub.
Run ``docker-compose up`` to start the hub if you have chosen this option.

Expand Down

0 comments on commit 0e17d00

Please sign in to comment.