summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJakob Lykke Andersen <Jakob@caput.dk>2020-09-13 16:25:09 +0200
committerJakob Lykke Andersen <Jakob@caput.dk>2020-09-13 16:37:53 +0200
commit500f45fd4c34559cdbf9f28eae3e159fc5b7f2d8 (patch)
tree656a3a6c2c32de8d8feb0a089c9cf42426f9d86d /doc
parent1d0b424898db665db866648c7aab01bf6ed7e04d (diff)
downloadsphinx-git-500f45fd4c34559cdbf9f28eae3e159fc5b7f2d8.tar.gz
C, recursive alias declarations
Fixes sphinx-doc/sphinx#8141
Diffstat (limited to 'doc')
-rw-r--r--doc/usage/restructuredtext/domains.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst
index 311b03d66..f3754ab7c 100644
--- a/doc/usage/restructuredtext/domains.rst
+++ b/doc/usage/restructuredtext/domains.rst
@@ -744,6 +744,18 @@ The following directive can be used for this purpose.
.. versionadded:: 3.2
+
+ .. rubric:: Options
+
+ .. rst:directive:option:: maxdepth: int
+
+ Insert nested declarations as well, up to the total depth given.
+ Use 0 for infinite depth and 1 for just the mentioned declaration.
+ Defaults to 1.
+
+ .. versionadded:: 3.3
+
+
.. c:namespace-pop::