* [PATCH] doc: Sphinx's option ':noindex:' have been rename into ':noindexentry:'
@ 2020-11-13 6:56 Luc Van Oostenryck
0 siblings, 0 replies; only message in thread
From: Luc Van Oostenryck @ 2020-11-13 6:56 UTC (permalink / raw)
To: linux-sparse; +Cc: Luc Van Oostenryck
and instead of keeping the old name for compatibility, no it's rejected.
But well, purity of language is surely much more important than compatibility.
*long deep sigh*
So, use the new name (but it will for sure create problems when using
an older version of Sphinx).
Signed-off-by: Luc Van Oostenryck <luc.vanoostenryck@gmail.com>
---
Documentation/doc-guide.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/doc-guide.rst b/Documentation/doc-guide.rst
index 29f39aab360a..fb4cb32293a8 100644
--- a/Documentation/doc-guide.rst
+++ b/Documentation/doc-guide.rst
@@ -138,7 +138,7 @@ For example, a doc-block like::
will be displayed like this:
.. c:function:: int inc(int val)
- :noindex:
+ :noindexentry:
:param val: the value to increment
:return: the incremented value
--
2.29.2
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2020-11-13 6:57 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-13 6:56 [PATCH] doc: Sphinx's option ':noindex:' have been rename into ':noindexentry:' Luc Van Oostenryck
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.