diff options
| author | Georg Brandl <georg@python.org> | 2010-05-23 16:48:54 +0200 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-05-23 16:48:54 +0200 |
| commit | 2e77fec614c04bbf2c23bd7d2651b8cd24438a76 (patch) | |
| tree | d8917605fb0507547c94ead9c376c22c7b53d2c9 /doc | |
| parent | e59bf5c09746a9d03771b363609be184e90c58d4 (diff) | |
| download | sphinx-2e77fec614c04bbf2c23bd7d2651b8cd24438a76.tar.gz | |
Rename default_domain to primary_domain; give it special semantics.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 9 | ||||
| -rw-r--r-- | doc/domains.rst | 4 |
2 files changed, 9 insertions, 4 deletions
diff --git a/doc/config.rst b/doc/config.rst index 8c9c12c1..126679d1 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -192,12 +192,17 @@ General configuration .. versionadded:: 1.0 -.. confval:: default_domain +.. confval:: primary_domain .. index:: default; domain + primary; domain The name of the default :ref:`domain <domains>`. Can also be ``None`` to - disable a default domain. The default is ``'py'``. + disable a default domain. The default is ``'py'``. Those objects in other + domains (whether the domain name is given explicitly, or selected by a + :dir:`default-domain` directive) will have the domain name explicitly + prepended when named (e.g., when the default domain is C, Python functions + will be named "Python function", not just "function"). .. versionadded:: 1.0 diff --git a/doc/domains.rst b/doc/domains.rst index 0f62f176..161a81de 100644 --- a/doc/domains.rst +++ b/doc/domains.rst @@ -69,11 +69,11 @@ directive name. To avoid having to writing the domain name all the time when you e.g. only describe Python objects, a default domain can be selected with either the config -value :confval:`default_domain` or this directive: +value :confval:`primary_domain` or this directive: .. rst:directive:: .. default-domain:: name - Select a new default domain. While the :confval:`default_domain` selects a + Select a new default domain. While the :confval:`primary_domain` selects a global default, this only has an effect within the same file. If no other default is selected, the Python domain (named ``py``) is the default |