diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:24:36 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-09-13 15:24:36 +0200 |
| commit | ccc95ea626caf670ed18c4196f00566bf433d1ed (patch) | |
| tree | 3a1bc63291b88ca16a8f56c5ab5f9ccd755bda5c /doc/tutorial/describing-code.rst | |
| parent | 1677f416bc3f274694c705d26554eefe2484ed10 (diff) | |
| download | sphinx-git-ccc95ea626caf670ed18c4196f00566bf433d1ed.tar.gz | |
Amend explanation on the default-domain directive
Diffstat (limited to 'doc/tutorial/describing-code.rst')
| -rw-r--r-- | doc/tutorial/describing-code.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index bf6660b93..4e98f3605 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -54,8 +54,9 @@ Notice several things: The ``py:`` prefix specifies the :term:`domain`. You may configure the default domain so you can omit the prefix, either globally using the - :confval:`primary_domain` configuration, or per-file using the - :rst:dir:`default-domain` directive. + :confval:`primary_domain` configuration, or use the + :rst:dir:`default-domain` directive to change it from the point it is called + until the end of the file. For example, if you set it to ``py`` (the default), you can write ``.. function::`` directly. |