summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/usage/restructuredtext/field-lists.rst6
1 files changed, 6 insertions, 0 deletions
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``