Merge pull request sphinx-doc#7109 from sphinx-doc/6033_doc_for_tocdepth

docs: Add a restriction note about tocdepth (refs: sphinx-doc#6033)
tk0miya · Feb 8, 2020 · 1e5342f · 1e5342f
2 parents 1a52381 + f6acd06
commit 1e5342f
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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``