From 67506ba83391b8efe25e03cefda2f2e080939a6d Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Wed, 10 Dec 2025 09:06:30 +0100 Subject: [PATCH] Update DOCtor-RST to 1.77.0 and enable `no_relative_doc_path` rule --- .doctor-rst.yaml | 3 +++ .github/workflows/ci.yaml | 2 +- components/validator/resources.rst | 2 +- contributing/code/bugs.rst | 4 ++-- contributing/code/conventions.rst | 2 +- contributing/code/pull_requests.rst | 6 +++--- contributing/code/standards.rst | 2 +- contributing/code/tests.rst | 4 ++-- contributing/community/reviews.rst | 2 +- frontend/encore/copy-files.rst | 2 +- index.rst | 8 ++++---- reference/constraints/IsFalse.rst | 2 +- reference/constraints/IsNull.rst | 2 +- reference/constraints/IsTrue.rst | 2 +- routing.rst | 2 +- routing/routing_from_database.rst | 2 +- security.rst | 2 +- setup/symfony_cli.rst | 2 +- testing.rst | 2 +- 19 files changed, 28 insertions(+), 25 deletions(-) diff --git a/.doctor-rst.yaml b/.doctor-rst.yaml index 496a7c58ead..385d142c92f 100644 --- a/.doctor-rst.yaml +++ b/.doctor-rst.yaml @@ -63,6 +63,7 @@ rules: no_namespace_after_use_statements: ~ no_non_breaking_space: ~ no_php_open_tag_in_code_block_php_directive: ~ + no_relative_doc_path: ~ no_space_before_self_xml_closing_tag: ~ no_typographic_quotes: ~ non_static_phpunit_assertions: ~ @@ -108,6 +109,8 @@ exclude_rule_for_file: rule_name: no_php_open_tag_in_code_block_php_directive - path: frontend/create_ux_bundle.rst rule_name: argument_variable_must_match_type + - path: contributing/documentation/format.rst + rule_name: no_relative_doc_path # do not report as violation whitelist: diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index e7e9ce8595c..30606c3b682 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -72,7 +72,7 @@ jobs: key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }} - name: "Run DOCtor-RST" - uses: docker://oskarstark/doctor-rst:1.76.0 + uses: docker://oskarstark/doctor-rst:1.77.0 with: args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache diff --git a/components/validator/resources.rst b/components/validator/resources.rst index 32b8e26f8a8..958786ef72e 100644 --- a/components/validator/resources.rst +++ b/components/validator/resources.rst @@ -11,7 +11,7 @@ The Validator component collects that metadata using a set of loaders. .. seealso:: - You'll learn how to define the metadata in :doc:`metadata`. + You'll learn how to define the metadata in :doc:`/components/validator/metadata`. The StaticMethodLoader ---------------------- diff --git a/contributing/code/bugs.rst b/contributing/code/bugs.rst index b0a46766026..53487d65cf3 100644 --- a/contributing/code/bugs.rst +++ b/contributing/code/bugs.rst @@ -7,7 +7,7 @@ us make a better Symfony. .. warning:: If you think you've found a security issue, please use the special - :doc:`procedure ` instead. + :doc:`procedure ` instead. Before submitting a bug: @@ -44,7 +44,7 @@ If your problem definitely looks like a bug, report it using the official bug **Be wary that stack traces may contain sensitive information, and if it is the case, be sure to redact them prior to posting your stack trace.** -* *(optional)* Attach a :doc:`patch `. +* *(optional)* Attach a :doc:`patch `. .. _`Stack Overflow`: https://stackoverflow.com/questions/tagged/symfony .. _the Symfony Slack: https://symfony.com/slack-invite diff --git a/contributing/code/conventions.rst b/contributing/code/conventions.rst index 455bc8de0ed..50c6e77a4d4 100644 --- a/contributing/code/conventions.rst +++ b/contributing/code/conventions.rst @@ -1,7 +1,7 @@ Conventions =========== -The :doc:`standards` document describes the coding standards for the Symfony +The :doc:`standards ` document describes the coding standards for the Symfony projects and the internal and third-party bundles. This document describes coding standards and conventions used in the core framework to make it more consistent and predictable. You are encouraged to follow them in your own diff --git a/contributing/code/pull_requests.rst b/contributing/code/pull_requests.rst index 548fc6c190c..967dcea6c86 100644 --- a/contributing/code/pull_requests.rst +++ b/contributing/code/pull_requests.rst @@ -107,7 +107,7 @@ Check that the current Tests Pass ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Now that Symfony is installed, check that all unit tests pass for your -environment as explained in the dedicated :doc:`document `. +environment as explained in the dedicated :doc:`document `. .. _step-2-work-on-your-patch: @@ -216,8 +216,8 @@ Work on your Pull Request Work on the code as much as you want and commit as much as you want; but keep in mind the following: -* Read about the Symfony :doc:`conventions ` and follow the - coding :doc:`standards ` (use ``git diff --check`` to check for +* Read about the Symfony :doc:`conventions ` and follow the + coding :doc:`standards ` (use ``git diff --check`` to check for trailing spaces -- also read the tip below); * Add unit tests to prove that the bug is fixed or that the new feature diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst index ebfde7dfab4..cbe143dcdaa 100644 --- a/contributing/code/standards.rst +++ b/contributing/code/standards.rst @@ -249,7 +249,7 @@ Naming Conventions or ``Boolean``), ``int`` (instead of ``integer``), ``float`` (instead of ``double`` or ``real``); -* Don't forget to look at the more verbose :doc:`conventions` document for +* Don't forget to look at the more verbose :doc:`conventions ` document for more subjective naming considerations. .. _service-naming-conventions: diff --git a/contributing/code/tests.rst b/contributing/code/tests.rst index e6af1170e3d..3b6ff540728 100644 --- a/contributing/code/tests.rst +++ b/contributing/code/tests.rst @@ -4,11 +4,11 @@ Running Symfony Tests ===================== The Symfony project uses a CI (Continuous Integration) service which automatically runs tests -for any submitted :doc:`patch `. If the new code breaks any test, +for any submitted :doc:`patch `. If the new code breaks any test, the pull request will show an error message with a link to the full error details. In any case, it's a good practice to run tests locally before submitting a -:doc:`patch ` for inclusion, to check that you have not broken anything. +:doc:`patch ` for inclusion, to check that you have not broken anything. .. _phpunit: .. _dependencies_optional: diff --git a/contributing/community/reviews.rst b/contributing/community/reviews.rst index 06426c03985..a289885791e 100644 --- a/contributing/community/reviews.rst +++ b/contributing/community/reviews.rst @@ -125,7 +125,7 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps: pull request. Is that branch correct? * Bugs should be fixed in the oldest, maintained version that contains the - bug. Check :doc:`Symfony's Release Schedule ` to find the oldest + bug. Check :doc:`Symfony's Release Schedule ` to find the oldest currently supported version. * New features should always be added to the current development version. diff --git a/frontend/encore/copy-files.rst b/frontend/encore/copy-files.rst index 33eb3467af8..30770b6dfc3 100644 --- a/frontend/encore/copy-files.rst +++ b/frontend/encore/copy-files.rst @@ -56,7 +56,7 @@ install any missing dependencies. After running that command and restarting Encore, you're done! This will copy all files from ``assets/images`` into ``public/build/images``. -If you have :doc:`versioning enabled `, the copied files will +If you have :doc:`versioning enabled `, the copied files will include a hash based on their content. To render inside Twig, use the ``asset()`` function: diff --git a/index.rst b/index.rst index c566e5f8671..6281c8eda74 100644 --- a/index.rst +++ b/index.rst @@ -6,11 +6,11 @@ Symfony Documentation Quick Tour ---------- -Get started fast with the Symfony :doc:`Quick Tour `: +Get started fast with the Symfony :doc:`Quick Tour `: -* :doc:`quick_tour/the_big_picture` -* :doc:`quick_tour/flex_recipes` -* :doc:`quick_tour/the_architecture` +* :doc:`/quick_tour/the_big_picture` +* :doc:`/quick_tour/flex_recipes` +* :doc:`/quick_tour/the_architecture` Getting Started --------------- diff --git a/reference/constraints/IsFalse.rst b/reference/constraints/IsFalse.rst index 0b9ebe77491..fd0f597a7ce 100644 --- a/reference/constraints/IsFalse.rst +++ b/reference/constraints/IsFalse.rst @@ -5,7 +5,7 @@ Validates that a value is ``false``. Specifically, this checks to see if the value is exactly ``false``, exactly the integer ``0``, or exactly the string ``'0'``. -Also see :doc:`IsTrue `. +Also see :doc:`IsTrue `. ========== =================================================================== Applies to :ref:`property or method ` diff --git a/reference/constraints/IsNull.rst b/reference/constraints/IsNull.rst index 0f9726110ba..f6def0560c5 100644 --- a/reference/constraints/IsNull.rst +++ b/reference/constraints/IsNull.rst @@ -5,7 +5,7 @@ Validates that a value is exactly equal to ``null``. To force that a property is blank (blank string or ``null``), see the :doc:`/reference/constraints/Blank` constraint. To ensure that a property is not null, see :doc:`/reference/constraints/NotNull`. -Also see :doc:`NotNull `. +Also see :doc:`NotNull `. ========== =================================================================== Applies to :ref:`property or method ` diff --git a/reference/constraints/IsTrue.rst b/reference/constraints/IsTrue.rst index 678371f6e69..41dcc8fb444 100644 --- a/reference/constraints/IsTrue.rst +++ b/reference/constraints/IsTrue.rst @@ -4,7 +4,7 @@ IsTrue Validates that a value is ``true``. Specifically, this checks if the value is exactly ``true``, exactly the integer ``1``, or exactly the string ``'1'``. -Also see :doc:`IsFalse `. +Also see :doc:`IsFalse `. ========== =================================================================== Applies to :ref:`property or method ` diff --git a/routing.rst b/routing.rst index 541ba971f67..8c6631d16cc 100644 --- a/routing.rst +++ b/routing.rst @@ -446,7 +446,7 @@ can use any of these variables created by Symfony: You can also use these functions: ``env(string $name)`` - Returns the value of a variable using :doc:`Environment Variable Processors ` + Returns the value of a variable using :doc:`Environment Variable Processors ` ``service(string $alias)`` Returns a routing condition service. diff --git a/routing/routing_from_database.rst b/routing/routing_from_database.rst index 2604aca5299..b819aea5bf9 100644 --- a/routing/routing_from_database.rst +++ b/routing/routing_from_database.rst @@ -18,7 +18,7 @@ For these cases, the ``DynamicRouter`` offers an alternative approach: * Writes only affect the index of the database, which is very efficient. When all routes are known during deploy time and the number is not too -high, using a :doc:`custom route loader ` is the +high, using a :doc:`custom route loader ` is the preferred way to add more routes. When working with only one type of objects, a slug parameter on the object and the ``#[ParamConverter]`` attribute works fine (see `FrameworkExtraBundle`_) . diff --git a/security.rst b/security.rst index 4ce2b484323..cba7a29333c 100644 --- a/security.rst +++ b/security.rst @@ -467,7 +467,7 @@ You can also manually hash a password by running: $ php bin/console security:hash-password Read more about all available hashers and password migration in -:doc:`security/passwords`. +:doc:`/security/passwords`. .. versionadded:: 6.2 diff --git a/setup/symfony_cli.rst b/setup/symfony_cli.rst index 188f7173664..99ba2a58f4f 100644 --- a/setup/symfony_cli.rst +++ b/setup/symfony_cli.rst @@ -366,7 +366,7 @@ Docker Integration ------------------ The Symfony CLI provides full `Docker`_ integration for projects that -use it. To learn more about Docker and Symfony, see :doc:`docker`. +use it. To learn more about Docker and Symfony, see :doc:`/setup/docker`. The local server automatically detects Docker services and exposes their connection information as environment variables. diff --git a/testing.rst b/testing.rst index 6ad82ca7de1..86aada240d3 100644 --- a/testing.rst +++ b/testing.rst @@ -364,7 +364,7 @@ After that, you can create the test database and all tables using: .. tip:: You can run these commands to create the database during the - :doc:`test bootstrap process `. + :doc:`test bootstrap process `. .. tip::