mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
1cfb68d8be
* The directive option ``:noindex:`` was renamed to ``:no-index:``. * The directive option ``:noindexentry:`` was renamed to ``:no-index-entry:``. * The directive option ``:nocontentsentry:`` was renamed to ``:no-contents-entry:``. The previous names are retained as aliases, but will be deprecated and removed in a future version of Sphinx (9.0 or later).
47 lines
709 B
Plaintext
47 lines
709 B
Plaintext
:tocdepth: 2
|
|
|
|
i18n with docfields
|
|
===================
|
|
|
|
.. single TypedField
|
|
|
|
.. class:: Cls1
|
|
:no-index:
|
|
|
|
:param param: description of parameter param
|
|
|
|
.. grouped TypedFields
|
|
|
|
.. class:: Cls2
|
|
:no-index:
|
|
|
|
:param foo: description of parameter foo
|
|
:param bar: description of parameter bar
|
|
|
|
|
|
.. single GroupedField
|
|
|
|
.. class:: Cls3(values)
|
|
:no-index:
|
|
|
|
:raises ValueError: if the values are out of range
|
|
|
|
.. grouped GroupedFields
|
|
|
|
.. class:: Cls4(values)
|
|
:no-index:
|
|
|
|
:raises TypeError: if the values are not valid
|
|
:raises ValueError: if the values are out of range
|
|
|
|
|
|
.. single Field
|
|
|
|
.. class:: Cls5
|
|
:no-index:
|
|
|
|
:returns: a new :class:`Cls3` instance
|
|
|
|
.. Field is never grouped
|
|
|