diff --git a/.doctor-rst.yaml b/.doctor-rst.yaml index 209d697b25f..3bca2485231 100644 --- a/.doctor-rst.yaml +++ b/.doctor-rst.yaml @@ -47,6 +47,7 @@ rules: space_between_label_and_link_in_doc: ~ space_between_label_and_link_in_ref: ~ string_replacement: ~ + title_underline_length_must_match_title_length: ~ typo: ~ unused_links: ~ use_deprecated_directive_instead_of_versionadded: ~ diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 89f4938c6b5..1139dcddf94 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -73,7 +73,7 @@ jobs: key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }} - name: "Run DOCtor-RST" - uses: docker://oskarstark/doctor-rst:1.40.1 + uses: docker://oskarstark/doctor-rst:1.41.0 with: args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache diff --git a/best_practices.rst b/best_practices.rst index 32af3400c0a..159868118b3 100644 --- a/best_practices.rst +++ b/best_practices.rst @@ -229,7 +229,7 @@ important parts of your application. .. _best-practice-controller-annotations: Use Attributes or Annotations to Configure Routing, Caching, and Security -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Using attributes or annotations for routing, caching, and security simplifies configuration. You don't need to browse several files created with different @@ -445,7 +445,7 @@ specific tests for each page. .. _hardcode-urls-in-a-functional-test: Hard-code URLs in a Functional Test -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ In Symfony applications, it's recommended to :ref:`generate URLs ` using routes to automatically update all links when a URL changes. However, if a diff --git a/components/lock.rst b/components/lock.rst index fa048e56264..0907dc114ba 100644 --- a/components/lock.rst +++ b/components/lock.rst @@ -70,7 +70,7 @@ method can be safely called repeatedly, even if the lock is already acquired. third argument of the ``createLock()`` method to ``false``. Serializing Locks ------------------- +----------------- The :class:`Symfony\\Component\\Lock\\Key` contains the state of the :class:`Symfony\\Component\\Lock\\Lock` and can be serialized. This diff --git a/components/runtime.rst b/components/runtime.rst index 7b187acaeee..c0cf100f809 100644 --- a/components/runtime.rst +++ b/components/runtime.rst @@ -3,7 +3,7 @@ single: Components; Runtime The Runtime Component -====================== +===================== The Runtime Component decouples the bootstrapping logic from any global state to make sure the application can run with runtimes like PHP-PM, ReactPHP, diff --git a/components/serializer.rst b/components/serializer.rst index 4034de81a5e..5a95823163d 100644 --- a/components/serializer.rst +++ b/components/serializer.rst @@ -1069,7 +1069,7 @@ context to pass in these options using the key ``json_encode_options`` or $this->serializer->serialize($data, 'json', ['json_encode_options' => \JSON_PRESERVE_ZERO_FRACTION]); The ``CsvEncoder`` -~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~ The ``CsvEncoder`` encodes to and decodes from CSV. diff --git a/controller.rst b/controller.rst index 13537ce27c7..e39af6dd3a0 100644 --- a/controller.rst +++ b/controller.rst @@ -19,7 +19,7 @@ to render the content of a page. single: Controller; Basic example A Basic Controller -------------------- +------------------ While a controller can be any PHP callable (function, method on an object, or a ``Closure``), a controller is usually a method inside a controller diff --git a/frontend/encore/bootstrap.rst b/frontend/encore/bootstrap.rst index 561bef79dde..f5b3959eafd 100644 --- a/frontend/encore/bootstrap.rst +++ b/frontend/encore/bootstrap.rst @@ -74,7 +74,7 @@ Now, require bootstrap from any of your JavaScript files: }); Using Bootstrap with Turbo ---------------------------- +-------------------------- If you are using bootstrap with Turbo Drive, to allow your JavaScript to load on each page change, wrap the initialization in a ``turbo:load`` event listener: diff --git a/frontend/encore/virtual-machine.rst b/frontend/encore/virtual-machine.rst index 793a74e3d40..c24d2b3670b 100644 --- a/frontend/encore/virtual-machine.rst +++ b/frontend/encore/virtual-machine.rst @@ -93,7 +93,7 @@ connections: otherwise other computers can have access to it. Fix "Invalid Host header" Issue -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Webpack will respond ``Invalid Host header`` when trying to access files from the dev-server. To fix this, set the ``allowedHosts`` option: diff --git a/mercure.rst b/mercure.rst index f6dfc33c90a..be70ae7ef92 100644 --- a/mercure.rst +++ b/mercure.rst @@ -614,7 +614,7 @@ Checkout `the dedicated API Platform documentation`_ to learn more about its Mercure support. Testing --------- +------- During unit testing it's usually not needed to send updates to Mercure. diff --git a/reference/configuration/framework.rst b/reference/configuration/framework.rst index 66e9d7f9f76..782f4c14173 100644 --- a/reference/configuration/framework.rst +++ b/reference/configuration/framework.rst @@ -1227,7 +1227,7 @@ The value of this option is an associative array of ``domain => IP address`` (e.g ``['symfony.com' => '46.137.106.254', ...]``). retry_strategy -............... +.............. **type**: ``string`` diff --git a/reference/configuration/security.rst b/reference/configuration/security.rst index 40e1c7ef456..672d93b0b0a 100644 --- a/reference/configuration/security.rst +++ b/reference/configuration/security.rst @@ -413,7 +413,7 @@ If ``true``, users are always redirected to the default target path regardless of the previous URL that was stored in the session. default_target_path -.................... +................... **type**: ``string`` **default**: ``/`` diff --git a/reference/forms/types/choice.rst b/reference/forms/types/choice.rst index 59c75fb6ac5..6775b9d7f6c 100644 --- a/reference/forms/types/choice.rst +++ b/reference/forms/types/choice.rst @@ -318,7 +318,7 @@ Field Variables faster to use the :ref:`selectedchoice ` test. Accessing Form Choice Data -........................... +.......................... The ``form.vars`` variable of each choice entry holds data such as whether the choice is selected or not. If you need to get the full list of choices data and diff --git a/reference/forms/types/tel.rst b/reference/forms/types/tel.rst index 8a99b6752c5..aebbe3de487 100644 --- a/reference/forms/types/tel.rst +++ b/reference/forms/types/tel.rst @@ -2,7 +2,7 @@ single: Forms; Fields; TelType TelType Field -=============== +============= The ``TelType`` field is a text field that is rendered using the HTML5 ```` tag. Following the recommended HTML5 behavior, the value diff --git a/reference/twig_reference.rst b/reference/twig_reference.rst index 85c44bd57a3..4cb698217af 100644 --- a/reference/twig_reference.rst +++ b/reference/twig_reference.rst @@ -131,7 +131,7 @@ and :ref:`reference-assets-json-manifest-path` configuration options. Read more about :ref:`linking to web assets from templates `. asset_version -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~ .. code-block:: twig