Skip to content

Commit

Permalink
Added a note about not using relative internal links in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
javiereguiluz committed Sep 13, 2014
1 parent 79375ae commit 991ff6f
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions contributing/documentation/format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Adding Links

.. code-block:: rst
:doc:`/path/to/page`
:doc:`/absolute/path/to/page`
The page name should not include the file extension (``.rst``). For example:

Expand All @@ -135,7 +135,18 @@ The page name should not include the file extension (``.rst``). For example:
:doc:`/cookbook/configuration/environments`
The title of the linked page will be automaticall used as the text of the link.
Although they are technically correct, avoid the use of relative internal links
such as the following:

.. code-block:: rst
:doc:`controller`
:doc:`event_dispatcher/introduction`
:doc:`environments`
The title of the linked page will be automatically used as the text of the link.
If you want to modify that title, use this alternative syntax:

.. code-block:: rst
Expand Down

0 comments on commit 991ff6f

Please sign in to comment.