Skip to content

Commit 5ed02f3

Browse files
committed
minor #21633 Update DOCtor-RST to 1.77.0 and enable no_relative_doc_path rule (OskarStark)
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- Update DOCtor-RST to 1.77.0 and enable `no_relative_doc_path` rule - Require DOCtor-RST 1.77.0 - Enable `no_relative_doc_path` rule to ensure `:doc:` directives use absolute paths ### Refs * #21614 (comment) `@wouterj` * OskarStark/doctor-rst#2180 * OskarStark/doctor-rst#2213 I will take care of the upmerge and fixing the other issues in the upper branches, once approved. Commits ------- 67506ba Update DOCtor-RST to 1.77.0 and enable `no_relative_doc_path` rule
2 parents 9e285d6 + 67506ba commit 5ed02f3

File tree

19 files changed

+28
-25
lines changed

19 files changed

+28
-25
lines changed

.doctor-rst.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ rules:
6363
no_namespace_after_use_statements: ~
6464
no_non_breaking_space: ~
6565
no_php_open_tag_in_code_block_php_directive: ~
66+
no_relative_doc_path: ~
6667
no_space_before_self_xml_closing_tag: ~
6768
no_typographic_quotes: ~
6869
non_static_phpunit_assertions: ~
@@ -108,6 +109,8 @@ exclude_rule_for_file:
108109
rule_name: no_php_open_tag_in_code_block_php_directive
109110
- path: frontend/create_ux_bundle.rst
110111
rule_name: argument_variable_must_match_type
112+
- path: contributing/documentation/format.rst
113+
rule_name: no_relative_doc_path
111114

112115
# do not report as violation
113116
whitelist:

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ jobs:
7272
key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}
7373

7474
- name: "Run DOCtor-RST"
75-
uses: docker://oskarstark/doctor-rst:1.76.0
75+
uses: docker://oskarstark/doctor-rst:1.77.0
7676
with:
7777
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache
7878

components/validator/resources.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Validator component collects that metadata using a set of loaders.
1111

1212
.. seealso::
1313

14-
You'll learn how to define the metadata in :doc:`metadata`.
14+
You'll learn how to define the metadata in :doc:`/components/validator/metadata`.
1515

1616
The StaticMethodLoader
1717
----------------------

contributing/code/bugs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ us make a better Symfony.
77
.. warning::
88

99
If you think you've found a security issue, please use the special
10-
:doc:`procedure <security>` instead.
10+
:doc:`procedure </contributing/code/security>` instead.
1111

1212
Before submitting a bug:
1313

@@ -44,7 +44,7 @@ If your problem definitely looks like a bug, report it using the official bug
4444
**Be wary that stack traces may contain sensitive information, and if it is
4545
the case, be sure to redact them prior to posting your stack trace.**
4646

47-
* *(optional)* Attach a :doc:`patch <pull_requests>`.
47+
* *(optional)* Attach a :doc:`patch </contributing/code/pull_requests>`.
4848

4949
.. _`Stack Overflow`: https://stackoverflow.com/questions/tagged/symfony
5050
.. _the Symfony Slack: https://symfony.com/slack-invite

contributing/code/conventions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Conventions
22
===========
33

4-
The :doc:`standards` document describes the coding standards for the Symfony
4+
The :doc:`standards </contributing/code/standards>` document describes the coding standards for the Symfony
55
projects and the internal and third-party bundles. This document describes
66
coding standards and conventions used in the core framework to make it more
77
consistent and predictable. You are encouraged to follow them in your own

contributing/code/pull_requests.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Check that the current Tests Pass
107107
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108108

109109
Now that Symfony is installed, check that all unit tests pass for your
110-
environment as explained in the dedicated :doc:`document <tests>`.
110+
environment as explained in the dedicated :doc:`document </contributing/code/tests>`.
111111

112112
.. _step-2-work-on-your-patch:
113113

@@ -216,8 +216,8 @@ Work on your Pull Request
216216
Work on the code as much as you want and commit as much as you want; but keep
217217
in mind the following:
218218

219-
* Read about the Symfony :doc:`conventions <conventions>` and follow the
220-
coding :doc:`standards <standards>` (use ``git diff --check`` to check for
219+
* Read about the Symfony :doc:`conventions </contributing/code/conventions>` and follow the
220+
coding :doc:`standards </contributing/code/standards>` (use ``git diff --check`` to check for
221221
trailing spaces -- also read the tip below);
222222

223223
* Add unit tests to prove that the bug is fixed or that the new feature

contributing/code/standards.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Naming Conventions
249249
or ``Boolean``), ``int`` (instead of ``integer``), ``float`` (instead of
250250
``double`` or ``real``);
251251

252-
* Don't forget to look at the more verbose :doc:`conventions` document for
252+
* Don't forget to look at the more verbose :doc:`conventions </contributing/code/conventions>` document for
253253
more subjective naming considerations.
254254

255255
.. _service-naming-conventions:

contributing/code/tests.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ Running Symfony Tests
44
=====================
55

66
The Symfony project uses a CI (Continuous Integration) service which automatically runs tests
7-
for any submitted :doc:`patch <pull_requests>`. If the new code breaks any test,
7+
for any submitted :doc:`patch </contributing/code/pull_requests>`. If the new code breaks any test,
88
the pull request will show an error message with a link to the full error details.
99

1010
In any case, it's a good practice to run tests locally before submitting a
11-
:doc:`patch <pull_requests>` for inclusion, to check that you have not broken anything.
11+
:doc:`patch </contributing/code/pull_requests>` for inclusion, to check that you have not broken anything.
1212

1313
.. _phpunit:
1414
.. _dependencies_optional:

contributing/community/reviews.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Pick a pull request from the `PRs in need of review`_ and follow these steps:
125125
pull request. Is that branch correct?
126126

127127
* Bugs should be fixed in the oldest, maintained version that contains the
128-
bug. Check :doc:`Symfony's Release Schedule <releases>` to find the oldest
128+
bug. Check :doc:`Symfony's Release Schedule </contributing/community/releases>` to find the oldest
129129
currently supported version.
130130

131131
* New features should always be added to the current development version.

frontend/encore/copy-files.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ install any missing dependencies. After running that command and restarting
5656
Encore, you're done!
5757

5858
This will copy all files from ``assets/images`` into ``public/build/images``.
59-
If you have :doc:`versioning enabled <versioning>`, the copied files will
59+
If you have :doc:`versioning enabled </frontend/encore/versioning>`, the copied files will
6060
include a hash based on their content.
6161

6262
To render inside Twig, use the ``asset()`` function:

0 commit comments

Comments
 (0)