diff options
author | Georg Brandl <georg@python.org> | 2009-10-27 19:58:40 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2009-10-27 19:58:40 +0100 |
commit | d12ad380f28c0fccff7442035f183c2ee94e9cff (patch) | |
tree | 711c0a9ff59296f68b5f7d5ebe10fe0f5db92453 /doc/markup | |
parent | 213eba02250d003ebd25d2e883ffcc69b37fbd5d (diff) | |
download | sphinx-git-d12ad380f28c0fccff7442035f183c2ee94e9cff.tar.gz |
Finish renaming description units to object (description)s.
Diffstat (limited to 'doc/markup')
-rw-r--r-- | doc/markup/desc.rst | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/markup/desc.rst b/doc/markup/desc.rst index 058b5137d..4df9f6213 100644 --- a/doc/markup/desc.rst +++ b/doc/markup/desc.rst @@ -67,10 +67,12 @@ The directives you can use for module declarations are: .. _desc-units: -Object description units ------------------------- +Object descriptions +------------------- -There are a number of directives used to describe specific features provided by +.. XXX generalize for domains + +There are a number of directives used to describe specific objects provided by modules. Each directive requires one or more signatures to provide basic information about what is being described, and the content should be the description. The basic version makes entries in the general index; if no index @@ -243,7 +245,7 @@ Info field lists .. versionadded:: 0.4 -Inside description unit directives, reST field lists with these fields are +Inside object description directives, reST field lists with these fields are recognized and formatted nicely: * ``param``, ``parameter``, ``arg``, ``argument``, ``key``, ``keyword``: @@ -340,8 +342,8 @@ There is a set of directives allowing documenting command-line programs: .. versionadded:: 0.5 -Custom description units -~~~~~~~~~~~~~~~~~~~~~~~~ +Custom object types +~~~~~~~~~~~~~~~~~~~ There is also a generic version of these directives: @@ -356,4 +358,4 @@ There is also a generic version of these directives: Describes a Python bytecode instruction. Extensions may add more directives like that, using the -:func:`~sphinx.application.Sphinx.add_description_unit` method. +:func:`~sphinx.application.Sphinx.add_object_type` method. |