8000 docs(referencing.rst): add additional data about :doc: role by vwheeler63 · Pull Request #13587 · sphinx-doc/sphinx · GitHub
[go: up one dir, main page]
Skip to content

docs(referencing.rst): add additional data about :doc: role #13587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 8, 2025
Merged

docs(referencing.rst): add additional data about :doc: role #13587

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3c6d8c5
docs(referencing.rst): add additional data about :doc: role
vwheeler63 May 21, 2025
be1f9be
docs: re-wording per request.
vwheeler63 May 22, 2025
b29194a
docs: decided the 2nd version is more clear and complete.
vwheeler63 May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: re-wording per request.
  • Loading branch information
@vwheeler63
vwheeler63 committed May 22, 2025
commit be1f9bea9400e8672912c9475cebb17fd7330c60
7 changes: 2 additions & 5 deletions doc/usage/referencing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,18 +136,15 @@ There is also a way to directly link to documents:

.. rst:role:: doc

Link to the specified document; the document name can be specified in
absolute or relative fashion. For example, if the reference
Link to the specified document; the document name is a case-sensitive
relative or absolute path. For example, if the reference
``:doc:`parrot``` occurs in the document ``sketches/index``, then the link
refers to ``sketches/parrot``. If the reference is ``:doc:`/people``` or
``:doc:`../people```, the link refers to ``people``.

If no explicit link text is given (like usual: ``:doc:`Monty Python members
</people>```), the link caption will be the title of the given document.

Note that the string inside the single quotes must be a case-sensitive with
the file name, even on Windows.


Referencing downloadable files
------------------------------
Expand Down
Loading
0