diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-06 16:29:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-06 16:29:43 +0200 |
| commit | d505635224e279e553f486eaa2590d992d9f14a2 (patch) | |
| tree | 56aa75fde80a29e5396c70ad8c542755cd045ca9 /doc/tutorial | |
| parent | da93cfc07ff675d62f9a83f2bf48acd674da5532 (diff) | |
| download | sphinx-git-d505635224e279e553f486eaa2590d992d9f14a2.tar.gz | |
Be more explicit on automatic xref generation
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index a690e9d0a..8214eb6b0 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -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: |