Skip to content

Commit 991ff6f

Browse files
committed
Added a note about not using relative internal links in the doc
1 parent 79375ae commit 991ff6f

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

contributing/documentation/format.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Adding Links
123123

124124
.. code-block:: rst
125125
126-
:doc:`/path/to/page`
126+
:doc:`/absolute/path/to/page`
127127
128128
The page name should not include the file extension (``.rst``). For example:
129129

@@ -135,7 +135,18 @@ The page name should not include the file extension (``.rst``). For example:
135135
136136
:doc:`/cookbook/configuration/environments`
137137
138-
The title of the linked page will be automaticall used as the text of the link.
138+
Although they are technically correct, avoid the use of relative internal links
139+
such as the following:
140+
141+
.. code-block:: rst
142+
143+
:doc:`controller`
144+
145+
:doc:`event_dispatcher/introduction`
146+
147+
:doc:`environments`
148+
149+
The title of the linked page will be automatically used as the text of the link.
139150
If you want to modify that title, use this alternative syntax:
140151

141152
.. code-block:: rst

0 commit comments

Comments
 (0)