Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit eeabdee

Browse files
committed
DOC: Clarify the difference between document and section references
1 parent 0dc8c2f commit eeabdee

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

doc/devel/document.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,9 +194,17 @@ nor the ````literal```` role:
194194
Refer to other documents and sections
195195
-------------------------------------
196196

197-
Sphinx_ allows internal references_ between documents.
197+
Sphinx_ supports internal references_:
198198

199-
Documents can be linked with the ``:doc:`` directive:
199+
========= =========================== ===========================================
200+
Directive Links target Representation in rendered HTML
201+
========= =========================== ===========================================
202+
``:doc:`` document link to a page
203+
``:ref:`` ReST label (associated with link to an anchor associated with a heading
204+
a section)
205+
========= =========================== ===========================================
206+
207+
Examples:
200208

201209
.. code-block:: rst
202210

0 commit comments

Comments
 (0)