File tree Expand file tree Collapse file tree 1 file changed +13
-2
lines changed
contributing/documentation Expand file tree Collapse file tree 1 file changed +13
-2
lines changed Original file line number Diff line number Diff line change @@ -123,7 +123,7 @@ Adding Links
123
123
124
124
.. code-block :: rst
125
125
126
- :doc:`/path/to/page`
126
+ :doc:`/absolute/ path/to/page`
127
127
128
128
The page name should not include the file extension (``.rst ``). For example:
129
129
@@ -135,7 +135,18 @@ The page name should not include the file extension (``.rst``). For example:
135
135
136
136
:doc:`/cookbook/configuration/environments`
137
137
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.
139
150
If you want to modify that title, use this alternative syntax:
140
151
141
152
.. code-block :: rst
You can’t perform that action at this time.
0 commit comments