IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Be more explicit on automatic xref generation

Browse Source 
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-06 16:29:43 +02:00
committed by GitHub
parent da93cfc07f
commit d505635224
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/tutorial/describing-code.rst
View File

@@ -77,7 +77,7 @@ you can use :rst:role:`py:func` for that, as follows:
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
will raise an exception.
In some contexts, Sphinx will generate a cross-reference automatically just
When generating code documentation, Sphinx will generate a cross-reference automatically just
by using the name of the object, without you having to explicitly use a role
for that. For example, you can describe the custom exception raised by the
function using the :rst:dir:`py:exception` directive: