diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-02-09 00:57:53 +0900 |
|---|---|---|
| committer | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-02-09 00:57:53 +0900 |
| commit | 2e87ee85a22279ee4ecc658f830520a88c90236d (patch) | |
| tree | 124b080e0203aead764362ba1e5bd11da62822e5 /doc/usage/restructuredtext | |
| parent | d4aeae475943aef9b935f7487baf90ccc1c58b42 (diff) | |
| parent | 1e5342faa9147c7a3c60e41dc7671e88f6795855 (diff) | |
| download | sphinx-git-2e87ee85a22279ee4ecc658f830520a88c90236d.tar.gz | |
Merge branch '2.0'
Diffstat (limited to 'doc/usage/restructuredtext')
| -rw-r--r-- | doc/usage/restructuredtext/domains.rst | 24 | ||||
| -rw-r--r-- | doc/usage/restructuredtext/field-lists.rst | 6 |
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index e107acac1..9c69fe88f 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -195,6 +195,18 @@ The following directives are provided for module and class contents: as "defined constants." Class and object attributes are not documented using this environment. + .. rubric:: options + + .. rst:directive:option:: type: type of the variable + :type: text + + .. versionadded:: 2.4 + + .. rst:directive:option:: value: initial value of the variable + :type: text + + .. versionadded:: 2.4 + .. rst:directive:: .. py:exception:: name Describes an exception class. The signature can, but need not include @@ -229,6 +241,18 @@ The following directives are provided for module and class contents: information about the type of the data to be expected and whether it may be changed directly. + .. rubric:: options + + .. rst:directive:option:: type: type of the attribute + :type: text + + .. versionadded:: 2.4 + + .. rst:directive:option:: value: initial value of the attribute + :type: text + + .. versionadded:: 2.4 + .. rst:directive:: .. py:method:: name(parameters) Describes an object method. The parameters should not include the ``self`` diff --git a/doc/usage/restructuredtext/field-lists.rst b/doc/usage/restructuredtext/field-lists.rst index fcecfe708..b84d238ba 100644 --- a/doc/usage/restructuredtext/field-lists.rst +++ b/doc/usage/restructuredtext/field-lists.rst @@ -30,6 +30,12 @@ At the moment, these metadata fields are recognized: :tocdepth: 2 + .. note:: + + This metadata effects to the depth of local toctree. But it does not + effect to the depth of *global* toctree. So this would not be change + the sidebar of some themes which uses global one. + .. versionadded:: 0.4 ``nocomments`` |
