LaTeX: improved doc of \sphinxtableofcontents (closes #10858)

sphinx-doc · Sep 24, 2022 · 89a656d · 89a656d
1 parent 6508121
commit 89a656d
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/latex.rst b/doc/latex.rst
@@ -1300,6 +1300,12 @@ Macros
      ``\sphinxtableofcontentshook``.  This macro is also executed by the
      ``'howto'`` docclass, but defaults to empty with it.
 
+  .. hint::
+
+     If adding to preamble the loading of ``tocloft`` package, also add to
+     preamble ``\renewcommand\sphinxtableofcontentshook{}`` else it will reset
+     ``\l@section`` and ``\l@subsection`` cancelling ``tocloft`` customization.
+
 - ``\sphinxmaketitle``: Used as the default setting of the ``'maketitle'``
   :confval:`latex_elements` key.
   Defined in the class files :file:`sphinxmanual.cls` and