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

Reword primary domains

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-09-06 16:24:11 +02:00
parent 722629b35b
commit da93cfc07f
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -55,9 +55,12 @@ Notice several things:
.. note::
Since Python is the default :term:`domain`, you can write
``.. function::`` directly without having to prefix the directive with
``py:``.
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.
For example, if you set it to ``py`` (the default), you can write
``.. function::`` directly.
Cross-referencing Python objects
--------------------------------