DOCS: improve :tocdepth: note (#12356)

This commit is contained in:
Ed Cormany 2024-05-06 22:49:08 -04:00 committed by GitHub
parent 88a54d8a13
commit 98f953e158
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -48,9 +48,9 @@ At the moment, these metadata fields are recognized:
.. 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.
This metadata affects the depth of the local toctree. But it does not
affect the depth of the *global* toctree. So this does not change
the sidebar of themes that use the global toctree.
.. versionadded:: 0.4