mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Consistently name the object description options (#11533)
* 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).
This commit is contained in:
1 parent
ff20efcd7e
commit
1cfb68d8be
31 files changed
+264
-212
No files matched your search
@@ -303,7 +303,7 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
|
||||
|
||||
.. versionadded:: 0.4
|
||||
|
||||
* All autodoc directives support the ``noindex`` flag option that has the
|
||||
* All autodoc directives support the ``no-index`` flag option that has the
|
||||
same effect as for standard :rst:dir:`py:function` etc. directives: no
|
||||
index entries are generated for the documented object (and all
|
||||
autodocumented members).
|
||||
@@ -724,7 +724,7 @@ There are also config values that you can set:
|
||||
.. versionadded:: 1.7
|
||||
|
||||
.. confval:: suppress_warnings
|
||||
:noindex:
|
||||
:no-index:
|
||||
|
||||
:mod:`autodoc` supports to suppress warning messages via
|
||||
:confval:`suppress_warnings`. It allows following warnings types in
|
||||
@@ -755,7 +755,7 @@ autodoc provides the following additional events:
|
||||
:param obj: the object itself
|
||||
:param options: the options given to the directive: an object with attributes
|
||||
``inherited_members``, ``undoc_members``, ``show_inheritance`` and
|
||||
``noindex`` that are true if the flag option of same name was given to the
|
||||
``no-index`` that are true if the flag option of same name was given to the
|
||||
auto directive
|
||||
:param lines: the lines of the docstring, see above
|
||||
|
||||
@@ -786,7 +786,7 @@ autodoc provides the following additional events:
|
||||
:param obj: the object itself
|
||||
:param options: the options given to the directive: an object with attributes
|
||||
``inherited_members``, ``undoc_members``, ``show_inheritance`` and
|
||||
``noindex`` that are true if the flag option of same name was given to the
|
||||
``no-index`` that are true if the flag option of same name was given to the
|
||||
auto directive
|
||||
:param signature: function signature, as a string of the form
|
||||
``"(parameter_1, parameter_2)"``, or ``None`` if introspection didn't
|
||||
@@ -849,5 +849,5 @@ member should be included in the documentation by using the following event:
|
||||
user handler does not override the decision
|
||||
:param options: the options given to the directive: an object with attributes
|
||||
``inherited_members``, ``undoc_members``, ``show_inheritance`` and
|
||||
``noindex`` that are true if the flag option of same name was given to the
|
||||
``no-index`` that are true if the flag option of same name was given to the
|
||||
auto directive
|
||||
@@ -349,7 +349,7 @@ Additionally, the following filters are available
|
||||
replaces the builtin Jinja `escape filter`_ that does html-escaping.
|
||||
|
||||
.. function:: underline(s, line='=')
|
||||
:noindex:
|
||||
:no-index:
|
||||
|
||||
Add a title underline to a piece of text.
|
||||
|
||||
|
||||
@@ -132,8 +132,8 @@ part (``sphinx``) from all names::
|
||||
:parts: -1
|
||||
|
||||
.. py:class:: sphinx.ext.inheritance_diagram.InheritanceDiagram
|
||||
:nocontentsentry:
|
||||
:noindexentry:
|
||||
:no-contents-entry:
|
||||
:no-index-entry:
|
||||
|
||||
The internal class that implements the ``inheritance-diagram`` directive.
|
||||
|
||||
|
||||
Reference in new issue
Block a user