diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index 9baaa8417..30bde8ea1 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -211,6 +211,12 @@ The following directives are provided for module and class contents: .. versionadded:: 4.0 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:data:: name Describes global data in a module, including both variables and values used @@ -237,6 +243,12 @@ The following directives are provided for module and class contents: .. versionadded:: 4.0 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:exception:: name Describes an exception class. The signature can, but need not include @@ -251,6 +263,12 @@ The following directives are provided for module and class contents: .. versionadded:: 3.1 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:class:: name .. py:class:: name(parameters) @@ -291,6 +309,12 @@ The following directives are provided for module and class contents: .. versionadded:: 3.1 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:attribute:: name Describes an object data attribute. The description should include @@ -317,6 +341,12 @@ The following directives are provided for module and class contents: .. versionadded:: 4.0 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:property:: name Describes an object property. @@ -340,6 +370,12 @@ The following directives are provided for module and class contents: .. rst:directive:option:: type: type of the property :type: text + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:: .. py:method:: name(parameters) Describes an object method. The parameters should not include the ``self`` @@ -385,6 +421,12 @@ The following directives are provided for module and class contents: .. versionadded:: 3.1 + .. rst::directive:option:: module + :type: text + + Describe the location where the object is defined. The default value is + the module specified by :rst:dir:`py:currentmodule`. + .. rst:directive:option:: property :type: no value