summaryrefslogtreecommitdiff
path: root/docs/dev/reST.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2024-04-19 13:24:20 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2026-05-07 16:19:28 +0200
commit50626ef150694555653016b47110dbbd7d2172f9 (patch)
tree537c0cda5705f98569557fe868bac80d0660494b /docs/dev/reST.rst
parent2f72fc4df2e108c219c1ce91e845e26d102a4f5c (diff)
[furo] remove `.. contents::` directives (#3408)
The directive creates a table of contents for the page. However, Furo includes a table of contents already in the sidebar. It is, thus, recommended to removing the `.. contents::` directive. [1] https://github.com/pradyunsg/furo/issues/88#issuecomment-803297274 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/reST.rst')
-rw-r--r--docs/dev/reST.rst6
1 files changed, 0 insertions, 6 deletions
diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst
index e539617b7..d3138a851 100644
--- a/docs/dev/reST.rst
+++ b/docs/dev/reST.rst
@@ -36,12 +36,6 @@ docs.live <make docs.live>` to build HTML while editing.
- SVG_, ImageMagick_
- DOT_, `Graphviz's dot`_, Graphviz_
-
-.. contents::
- :depth: 3
- :local:
- :backlinks: entry
-
Sphinx_ and reST_ have their place in the python ecosystem. Over that reST is
used in popular projects, e.g the Linux kernel documentation `[kernel doc]`_.