diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2020-02-08 18:37:06 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-08 18:37:06 +0900 |
| commit | 1e5342faa9147c7a3c60e41dc7671e88f6795855 (patch) | |
| tree | 4dd68c644f8d8098d1471d822e8a8df225734ba0 | |
| parent | 1a52381a0a7ae74673186571852423c55c4c9d7e (diff) | |
| parent | f6acd061f33fd2f1b9b33760660556bed66c5333 (diff) | |
| download | sphinx-git-1e5342faa9147c7a3c60e41dc7671e88f6795855.tar.gz | |
Merge pull request #7109 from sphinx-doc/6033_doc_for_tocdepth
docs: Add a restriction note about tocdepth (refs: #6033)
| -rw-r--r-- | doc/usage/restructuredtext/field-lists.rst | 6 |
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`` |