From f6acd061f33fd2f1b9b33760660556bed66c5333 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Fri, 7 Feb 2020 23:59:20 +0900 Subject: [PATCH] docs: Add a restriction note about tocdepth (refs: #6033) --- doc/usage/restructuredtext/field-lists.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/usage/restructuredtext/field-lists.rst b/doc/usage/restructuredtext/field-lists.rst index fcecfe708fe..b84d238baa8 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``