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

Amend explanation on the default-domain directive

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-09-13 15:24:36 +02:00
parent 1677f416bc
commit ccc95ea626
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -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.